Download OpenAPI specification:Download
IMPORTANT! You need specific permissions to access each endpoint: https://escl24.atlassian.net/wiki/spaces/HES/pages/6476169217/Autoryzacja
Returns total amount and count of payments. By default period is last year. Results are grouped in specified time frames.
| from | string Example: from=2021-03-23 date datetime or timestamp by default in UTC+0; required if 'to' is set |
| to | string Example: to=2021-04-23 15:37 date datetime or timestamp by default in UTC+0 |
| group | string Example: group=total total/yearly/monthly/daily/hourly |
{- "data": {
- "$timeframe": {
- "amount": 1234.57,
- "count": 13
}
}
}object (MetadataQuery) search by metadata | |
object (MetadataQuery) search by metadata private | |
| ids[] | string Example: ids[]=ids[]=5a61f3a1-1cd1-4e71-bf7d-0d3a159bd6b0&ids[]=33e37b2a-44e9-4d35-88db-d9a79a61e557 Ids array search |
{- "data": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Super App",
- "slug": "super_app",
- "version": "^1.0.0",
- "description": "App responsible for creating products page layout",
- "author": "Adam Nowak",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
]
}| url required | string Url of the applications microfrontend configuration page |
| name | string Name of the app |
| licence_key | string Licence key allowing to install application |
| allowed_permissions required | Array of strings Permissions granted to the app |
| public_app_permissions | Array of strings App permissions granted to unauthenticated users |
object (Metadata) | |
object (Metadata) |
{- "name": "Super App",
- "licence_key": "6v5e*B^%e8n76rn869r6n9r75nim76E&%nm996f7e87m",
- "allowed_permissions": [
- "products.add"
], - "public_app_permissions": [
- "review.add"
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Super App",
- "slug": "super_app",
- "version": "^1.0.0",
- "description": "App responsible for creating products page layout",
- "author": "Adam Nowak",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "permissions": [
- "roles.show_details"
]
}
}| id required | string Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0 |
{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Super App",
- "slug": "super_app",
- "version": "^1.0.0",
- "description": "App responsible for creating products page layout",
- "author": "Adam Nowak",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "permissions": [
- "roles.show_details"
]
}
}| object required | string Example: products |
| id required | string Example: 026bc5f6-8373-4aeb-972e-e78d72a67121 |
{- "data": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "event": "updated",
- "created_at": "2021-10-10T12:00:00",
- "old_values": [
- {
- "key": "value"
}
], - "new_values": [
- {
- "key": "value"
}
], - "issuer_type": "user",
- "issuer": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "email": "email@example.com",
- "name": "Johny Mielony",
- "avatar": "//www.gravatar.com/avatar/example.jpg",
- "roles": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Admin",
- "description": "Role with permission to everything",
- "assignable": true,
- "deletable": true,
- "users_count": 10,
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "consents": [
- {
- "name": "Consent One",
- "description_html": "<h1>Lorem ipsum dolor sit amet</h1>",
- "required": true,
- "value": true
}
], - "birthdate_date": "2000-01-01",
- "phone": "+48123456789",
- "phone_country": "PL",
- "phone_number": "12 345 67 89",
- "created_at": "2022-12-06T09:11",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
}
]
}| email required | string |
| password required | string |
| code | string |
{- "email": "admin@example.com",
- "password": "secret",
- "code": "XyDZR-M9GWZ"
}{- "data": {
- "token": "string",
- "identity_token": "string",
- "refresh_token": "string",
- "user": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "email": "email@example.com",
- "name": "Johny Mielony",
- "avatar": "//www.gravatar.com/avatar/example.jpg",
- "roles": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Admin",
- "description": "Role with permission to everything",
- "assignable": true,
- "deletable": true,
- "users_count": 10,
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "consents": [
- {
- "name": "Consent One",
- "description_html": "<h1>Lorem ipsum dolor sit amet</h1>",
- "required": true,
- "value": true
}
], - "birthdate_date": "2000-01-01",
- "phone": "+48123456789",
- "phone_country": "PL",
- "phone_number": "12 345 67 89",
- "created_at": "2022-12-06T09:11",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "shipping_addresses": [
- {
- "id": "1c8705ce-5fae-4468-b88a-8784cb5414a0",
- "default": true,
- "name": "Home",
- "address": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Johny Mielony",
- "address": "Gdańska 89/1",
- "vat": "9571099580",
- "zip": "80-200",
- "city": "Bydgoszcz",
- "country": "PL",
- "phone": "+48543234123"
}
}
], - "billing_addresses": [
- {
- "id": "1c8705ce-5fae-4468-b88a-8784cb5414a0",
- "default": true,
- "name": "Home",
- "address": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Johny Mielony",
- "address": "Gdańska 89/1",
- "vat": "9571099580",
- "zip": "80-200",
- "city": "Bydgoszcz",
- "country": "PL",
- "phone": "+48543234123"
}
}
]
}
}
}| name | string |
string | |
| password | string |
| birthday_date | string <date> |
| phone | string |
object |
{- "name": "Registered user",
- "email": "admin@example.com",
- "password": "secret",
- "birthday_date": "2000-01-01",
- "phone": "+48123456789",
- "consents": {
- "119c0a63-1ea1-4769-8d5f-169f68de5598": true,
- "02b97693-857c-4fb9-9999-47400ac5fbef": true
}
}{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "email": "admin@example.com",
- "name": "Registered user",
- "avatar": "//www.gravatar.com/avatar/example.jpg",
- "roles": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Authenticated",
- "description": "Authenticated user role",
- "assignable": false,
- "deletable": false
}
], - "consents": [
- {
- "name": "Consent one",
- "description_html": "<h1>Lorem ipsum dolor sit amet</h1>",
- "required": false,
- "value": true
}, - {
- "name": "Consent two",
- "description_html": "<h1>Lorem ipsum dolor sit amet</h1>",
- "required": true,
- "value": true
}
]
}
}| token required | string Example: be55ec43d8f58c85b333605f06be1163091a697f2460d86755ca4324cf56cccc User token |
| email required | string Example: test@test.test User email |
{- "data": {
- "token": "string",
- "identity_token": "string",
- "refresh_token": "string",
- "user": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "email": "email@example.com",
- "name": "Johny Mielony",
- "avatar": "//www.gravatar.com/avatar/example.jpg",
- "roles": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Admin",
- "description": "Role with permission to everything",
- "assignable": true,
- "deletable": true,
- "users_count": 10,
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "consents": [
- {
- "name": "Consent One",
- "description_html": "<h1>Lorem ipsum dolor sit amet</h1>",
- "required": true,
- "value": true
}
], - "birthdate_date": "2000-01-01",
- "phone": "+48123456789",
- "phone_country": "PL",
- "phone_number": "12 345 67 89",
- "created_at": "2022-12-06T09:11",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
}
}| refresh_token | string |
{- "refresh_token": "string"
}{- "data": {
- "token": "string",
- "identity_token": "string",
- "refresh_token": "string",
- "user": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "email": "email@example.com",
- "name": "Johny Mielony",
- "avatar": "//www.gravatar.com/avatar/example.jpg",
- "roles": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Admin",
- "description": "Role with permission to everything",
- "assignable": true,
- "deletable": true,
- "users_count": 10,
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "consents": [
- {
- "name": "Consent One",
- "description_html": "<h1>Lorem ipsum dolor sit amet</h1>",
- "required": true,
- "value": true
}
], - "birthdate_date": "2000-01-01",
- "phone": "+48123456789",
- "phone_country": "PL",
- "phone_number": "12 345 67 89",
- "created_at": "2022-12-06T09:11",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "shipping_addresses": [
- {
- "id": "1c8705ce-5fae-4468-b88a-8784cb5414a0",
- "default": true,
- "name": "Home",
- "address": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Johny Mielony",
- "address": "Gdańska 89/1",
- "vat": "9571099580",
- "zip": "80-200",
- "city": "Bydgoszcz",
- "country": "PL",
- "phone": "+48543234123"
}
}
], - "billing_addresses": [
- {
- "id": "1c8705ce-5fae-4468-b88a-8784cb5414a0",
- "default": true,
- "name": "Home",
- "address": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Johny Mielony",
- "address": "Gdańska 89/1",
- "vat": "9571099580",
- "zip": "80-200",
- "city": "Bydgoszcz",
- "country": "PL",
- "phone": "+48543234123"
}
}
]
}
}
}{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "email": "email@example.com",
- "name": "Johny Mielony",
- "avatar": "//www.gravatar.com/avatar/example.jpg",
- "roles": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Admin",
- "description": "Role with permission to everything",
- "assignable": true,
- "deletable": true,
- "users_count": 10,
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "consents": [
- {
- "name": "Consent One",
- "description_html": "<h1>Lorem ipsum dolor sit amet</h1>",
- "required": true,
- "value": true
}
], - "birthdate_date": "2000-01-01",
- "phone": "+48123456789",
- "phone_country": "PL",
- "phone_number": "12 345 67 89",
- "created_at": "2022-12-06T09:11",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "permissions": [
- "roles.show_details"
], - "preferences": {
- "successful_login_attempt_alert": true,
- "failed_login_attempt_alert": true,
- "new_localization_login_alert": true,
- "recovery_code_changed_alert": true
}, - "shipping_addresses": [
- {
- "id": "1c8705ce-5fae-4468-b88a-8784cb5414a0",
- "default": true,
- "name": "Home",
- "address": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Johny Mielony",
- "address": "Gdańska 89/1",
- "vat": "9571099580",
- "zip": "80-200",
- "city": "Bydgoszcz",
- "country": "PL",
- "phone": "+48543234123"
}
}
], - "billing_addresses": [
- {
- "id": "1c8705ce-5fae-4468-b88a-8784cb5414a0",
- "default": true,
- "name": "Home",
- "address": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Johny Mielony",
- "address": "Gdańska 89/1",
- "vat": "9571099580",
- "zip": "80-200",
- "city": "Bydgoszcz",
- "country": "PL",
- "phone": "+48543234123"
}
}
]
}
}| name | string |
| birthday_date | string <date> |
| phone | string |
object | |
object (Preferences) |
{- "name": "Test User",
- "birthday_date": "2000-01-01",
- "phone": "+48123456789",
- "consents": {
- "119c0a63-1ea1-4769-8d5f-169f68de5598": true,
- "02b97693-857c-4fb9-9999-47400ac5fbef": true
}, - "preferences": {
- "successful_login_attempt_alert": true,
- "failed_login_attempt_alert": true,
- "new_localization_login_alert": true,
- "recovery_code_changed_alert": true
}
}{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "email": "email@example.com",
- "name": "Johny Mielony",
- "avatar": "//www.gravatar.com/avatar/example.jpg",
- "roles": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Admin",
- "description": "Role with permission to everything",
- "assignable": true,
- "deletable": true,
- "users_count": 10,
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "consents": [
- {
- "name": "Consent One",
- "description_html": "<h1>Lorem ipsum dolor sit amet</h1>",
- "required": true,
- "value": true
}
], - "birthdate_date": "2000-01-01",
- "phone": "+48123456789",
- "phone_country": "PL",
- "phone_number": "12 345 67 89",
- "created_at": "2022-12-06T09:11",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "permissions": [
- "roles.show_details"
], - "preferences": {
- "successful_login_attempt_alert": true,
- "failed_login_attempt_alert": true,
- "new_localization_login_alert": true,
- "recovery_code_changed_alert": true
}
}
}| default required | boolean |
| name required | string |
required | object |
{- "default": true,
- "name": "Home",
- "address": {
- "name": "Jan Kowalski",
- "phone": 123456789,
- "address": "ul. Ulica 12",
- "zip": "12-123",
- "city": "Miasto",
- "country": "Polska",
- "vat": "string"
}
}{- "data": [
- {
- "id": "1c8705ce-5fae-4468-b88a-8784cb5414a0",
- "default": true,
- "name": "Home",
- "address": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Johny Mielony",
- "address": "Gdańska 89/1",
- "vat": "9571099580",
- "zip": "80-200",
- "city": "Bydgoszcz",
- "country": "PL",
- "phone": "+48543234123"
}
}
]
}| id required | string Example: 026bc5f6-8373-4aeb-972e-e78d72a67121 |
| default required | boolean |
| name required | string |
required | object |
{- "default": true,
- "name": "Home",
- "address": {
- "name": "Jan Kowalski",
- "phone": 123456789,
- "address": "ul. Ulica 12",
- "zip": "12-123",
- "city": "Miasto",
- "country": "Polska",
- "vat": "string"
}
}{- "data": [
- {
- "id": "1c8705ce-5fae-4468-b88a-8784cb5414a0",
- "default": true,
- "name": "Home",
- "address": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Johny Mielony",
- "address": "Gdańska 89/1",
- "vat": "9571099580",
- "zip": "80-200",
- "city": "Bydgoszcz",
- "country": "PL",
- "phone": "+48543234123"
}
}
]
}| id required | string Example: 026bc5f6-8373-4aeb-972e-e78d72a67121 |
{- "data": [
- {
- "id": "1c8705ce-5fae-4468-b88a-8784cb5414a0",
- "default": true,
- "name": "Home",
- "address": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Johny Mielony",
- "address": "Gdańska 89/1",
- "vat": "9571099580",
- "zip": "80-200",
- "city": "Bydgoszcz",
- "country": "PL",
- "phone": "+48543234123"
}
}
]
}| default required | boolean |
| name required | string |
required | object |
{- "default": true,
- "name": "Home",
- "address": {
- "name": "Jan Kowalski",
- "phone": 123456789,
- "address": "ul. Ulica 12",
- "zip": "12-123",
- "city": "Miasto",
- "country": "Polska",
- "vat": "string"
}
}{- "data": [
- {
- "id": "1c8705ce-5fae-4468-b88a-8784cb5414a0",
- "default": true,
- "name": "Home",
- "address": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Johny Mielony",
- "address": "Gdańska 89/1",
- "vat": "9571099580",
- "zip": "80-200",
- "city": "Bydgoszcz",
- "country": "PL",
- "phone": "+48543234123"
}
}
]
}| id required | string Example: 026bc5f6-8373-4aeb-972e-e78d72a67121 |
| default required | boolean |
| name required | string |
required | object |
{- "default": true,
- "name": "Home",
- "address": {
- "name": "Jan Kowalski",
- "phone": 123456789,
- "address": "ul. Ulica 12",
- "zip": "12-123",
- "city": "Miasto",
- "country": "Polska",
- "vat": "string"
}
}{- "data": [
- {
- "id": "1c8705ce-5fae-4468-b88a-8784cb5414a0",
- "default": true,
- "name": "Home",
- "address": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Johny Mielony",
- "address": "Gdańska 89/1",
- "vat": "9571099580",
- "zip": "80-200",
- "city": "Bydgoszcz",
- "country": "PL",
- "phone": "+48543234123"
}
}
]
}| id required | string Example: 026bc5f6-8373-4aeb-972e-e78d72a67121 |
{- "data": [
- {
- "id": "1c8705ce-5fae-4468-b88a-8784cb5414a0",
- "default": true,
- "name": "Home",
- "address": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Johny Mielony",
- "address": "Gdańska 89/1",
- "vat": "9571099580",
- "zip": "80-200",
- "city": "Bydgoszcz",
- "country": "PL",
- "phone": "+48543234123"
}
}
]
}| identity_token required | string Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0 |
{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "terms-and-conditions",
- "avatar": "Terms & Conditions",
- "permissions": [
- "roles.show_details"
]
}
}| AuthProviderKey required | string Enum: "facebook" "google" "apple" "github" "gitlab" "bitbucket" "linkedin" |
| client_id | string |
| client_secret | string |
| active | boolean |
{- "client_id": "38v92867932v48937y4",
- "client_secret": "209-387vn20hfj",
- "active": true
}{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "key": "google",
- "active": true,
- "client_id": "19279v71091hfd9u930",
- "client_secret": "akfj90238vh23oui2v"
}
}| AuthProviderKey required | string Enum: "facebook" "google" "apple" "github" "gitlab" "bitbucket" "linkedin" |
| return_url | string Must be same as the |
{
}{- "data": {
- "token": "string",
- "identity_token": "string",
- "refresh_token": "string",
- "user": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "email": "email@example.com",
- "name": "Johny Mielony",
- "avatar": "//www.gravatar.com/avatar/example.jpg",
- "roles": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Admin",
- "description": "Role with permission to everything",
- "assignable": true,
- "deletable": true,
- "users_count": 10,
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "consents": [
- {
- "name": "Consent One",
- "description_html": "<h1>Lorem ipsum dolor sit amet</h1>",
- "required": true,
- "value": true
}
], - "birthdate_date": "2000-01-01",
- "phone": "+48123456789",
- "phone_country": "PL",
- "phone_number": "12 345 67 89",
- "created_at": "2022-12-06T09:11",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
}
}| AuthProviderKey required | string Enum: "facebook" "google" "apple" "github" "gitlab" "bitbucket" "linkedin" |
| return_url | string |
{
}{- "data": {
- "redirect_url": "string"
}
}| country | string Example: country=DE |
| cart_value | number Example: cart_value=1200 cart total you want to display shipping price for |
object (MetadataQuery) search by metadata | |
object (MetadataQuery) search by metadata private | |
| ids[] | string Example: ids[]=ids[]=5a61f3a1-1cd1-4e71-bf7d-0d3a159bd6b0&ids[]=33e37b2a-44e9-4d35-88db-d9a79a61e557 Ids array search |
{- "data": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Next Day Courier",
- "price": 2,
- "public": true,
- "block_list": true,
- "payment_methods": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Heseya Pay",
- "alias": "heseya",
- "public": true,
- "icon": "string",
- "url": "string"
}
], - "countries": [
- {
- "code": "PL",
- "name": "Poland"
}
], - "price_ranges": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "start": 0,
- "prices": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "value": 19.97,
- "model_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "model_type": "App\\Models\\Product"
}
]
}
], - "shipping_time_min": 2,
- "shipping_time_max": 2,
- "shipping_points": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Johny Mielony",
- "address": "Gdańska 89/1",
- "vat": "9571099580",
- "zip": "80-200",
- "city": "Bydgoszcz",
- "country": "PL",
- "phone": "+48543234123"
}
], - "integration_key": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "shipping_type": "digital",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
]
}| name required | string |
| public | boolean |
| block_list | boolean |
| payment_methods | Array of strings |
| countries | Array of strings |
required | Array of objects |
| shipping_time_min required | number |
| shipping_time_max required | number |
Array of objects | |
| integration_key | string |
| shipping_type | string Enum: "digital" "address" "point" "point-external" |
object (Metadata) | |
object (Metadata) |
{- "name": "dpd",
- "public": true,
- "block_list": true,
- "payment_methods": [
- "026bc5f6-8373-4aeb-972e-e78d72a67121"
], - "countries": [
- "PL"
], - "price_ranges": [
- {
- "start": 0,
- "value": 18.7
}
], - "shipping_time_min": 2,
- "shipping_time_max": 3,
- "shipping_points": [
- {
- "name": "test address"
}
], - "integration_key": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "shipping_type": "digital",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Next Day Courier",
- "price": 2,
- "public": true,
- "block_list": true,
- "payment_methods": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Heseya Pay",
- "alias": "heseya",
- "public": true,
- "icon": "string",
- "url": "string"
}
], - "countries": [
- {
- "code": "PL",
- "name": "Poland"
}
], - "price_ranges": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "start": 0,
- "prices": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "value": 19.97,
- "model_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "model_type": "App\\Models\\Product"
}
]
}
], - "shipping_time_min": 2,
- "shipping_time_max": 2,
- "shipping_points": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Johny Mielony",
- "address": "Gdańska 89/1",
- "vat": "9571099580",
- "zip": "80-200",
- "city": "Bydgoszcz",
- "country": "PL",
- "phone": "+48543234123"
}
], - "integration_key": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "shipping_type": "digital",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
}| id required | string Example: d1365285-ad58-48da-88e2-99e9f4c0800d |
| name | string |
| public | boolean |
| block_list | boolean |
| payment_methods | Array of strings |
| countries | Array of strings |
Array of objects | |
| shipping_time_min | number |
| shipping_time_max | number |
Array of objects | |
| integration_key | string |
{- "name": "dpd",
- "public": true,
- "block_list": true,
- "payment_methods": [
- "026bc5f6-8373-4aeb-972e-e78d72a67121"
], - "countries": [
- "PL"
], - "price_ranges": [
- {
- "start": 0,
- "value": 18.7
}
], - "shipping_time_min": 2,
- "shipping_time_max": 3,
- "shipping_points": [
- {
- "name": "test address"
}
], - "integration_key": "026bc5f6-8373-4aeb-972e-e78d72a67121"
}{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Next Day Courier",
- "price": 2,
- "public": true,
- "block_list": true,
- "payment_methods": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Heseya Pay",
- "alias": "heseya",
- "public": true,
- "icon": "string",
- "url": "string"
}
], - "countries": [
- {
- "code": "PL",
- "name": "Poland"
}
], - "price_ranges": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "start": 0,
- "prices": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "value": 19.97,
- "model_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "model_type": "App\\Models\\Product"
}
]
}
], - "shipping_time_min": 2,
- "shipping_time_max": 2,
- "shipping_points": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Johny Mielony",
- "address": "Gdańska 89/1",
- "vat": "9571099580",
- "zip": "80-200",
- "city": "Bydgoszcz",
- "country": "PL",
- "phone": "+48543234123"
}
], - "integration_key": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "shipping_type": "digital",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
}object (MetadataQuery) search by metadata | |
object (MetadataQuery) search by metadata private | |
| ids[] | string Example: ids[]=ids[]=5a61f3a1-1cd1-4e71-bf7d-0d3a159bd6b0&ids[]=33e37b2a-44e9-4d35-88db-d9a79a61e557 Ids array search |
{- "data": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "quantity": "12.5",
- "item_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "order_product_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11",
- "from_unlimited": true
}
]
}{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "quantity": "12.5",
- "item_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "order_product_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11",
- "from_unlimited": true
}
}| id required | integer |
| quantity required | number |
| shipping_time | integer |
| shipping_date | string <date-time> |
{- "quantity": "12.5",
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11"
}{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "quantity": "12.5",
- "item_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "order_product_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11",
- "from_unlimited": true
}
}| search | string |
| description | string |
| for_role | string |
| ids[] | string Example: ids[]=ids[]=5a61f3a1-1cd1-4e71-bf7d-0d3a159bd6b0&ids[]=33e37b2a-44e9-4d35-88db-d9a79a61e557 Ids array search |
{- "data": [
- {
- "name": "Black",
- "description": "Black Weekend 2021",
- "type": "amount",
- "value": "50",
- "priority": 1,
- "target_type": "order-value",
- "target_is_allow_list": true,
- "active": true,
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "condition_groups": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "conditions": [
- {
- "type": "order-value",
- "min_value": 9.99,
- "max_value": 999.99,
- "include_taxes": true,
- "is_in_range": true,
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121"
}
]
}
], - "target_products": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "slug": "white-socks",
- "name": "White socks",
- "price": 10.99,
- "price_min": 11.99,
- "price_max": 19.99,
- "price_min_initial": 12.99,
- "price_max_initial": 20.99,
- "public": true,
- "visible": true,
- "available": true,
- "quantity_step": 0.05,
- "quantity": 20,
- "google_product_category": 2271,
- "vat_rate": 23,
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11",
- "shipping_digital": true,
- "purchase_limit_per_user": 5,
- "cover": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "tags": [
- {
- "name": "Sale",
- "color": 111111
}
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "has_schemas": true
}
], - "target_sets": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "AGD",
- "slug": "agd",
- "slug_suffix": "test",
- "slug_override": true,
- "public": true,
- "visible": true,
- "parent_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "children_ids": [
- "026bc5f6-8373-4aeb-972e-e78d72a67121"
], - "cover": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "attributes": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Screen size",
- "slug": "screen-size",
- "description": "Presented number is size of screen monitor",
- "min": "22",
- "max": "27",
- "type": 1,
- "global": true,
- "sortable": true,
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "target_shipping_methods": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Next Day Courier",
- "price": 2,
- "public": true,
- "block_list": true,
- "payment_methods": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Heseya Pay",
- "alias": "heseya",
- "public": true,
- "icon": "string",
- "url": "string"
}
], - "countries": [
- {
- "code": "PL",
- "name": "Poland"
}
], - "price_ranges": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "start": 0,
- "prices": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "value": 19.97,
- "model_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "model_type": "App\\Models\\Product"
}
]
}
], - "shipping_time_min": 2,
- "shipping_time_max": 2,
- "shipping_points": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Johny Mielony",
- "address": "Gdańska 89/1",
- "vat": "9571099580",
- "zip": "80-200",
- "city": "Bydgoszcz",
- "country": "PL",
- "phone": "+48543234123"
}
], - "integration_key": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "shipping_type": "digital",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
]
}| name required | string |
| description | string |
| type required | string Enum: "amount" "percentage" |
| value required | number |
| priority required | number |
| target_type required | string Enum: "order-value" "products" "shipping-price" "cheapest-product" |
| target_is_allow_list required | boolean |
| active required | boolean |
Array of objects (DiscountConditions_ConditionGroup) | |
| target_products | Array of strings |
| target_sets | Array of strings |
| target_shipping_methods | Array of strings |
object (Metadata) | |
object (Metadata) |
{- "name": "Black",
- "description": "Black Weekend 2021",
- "type": "amount",
- "value": "50",
- "priority": 1,
- "target_type": "order-value",
- "target_is_allow_list": true,
- "active": true,
- "condition_groups": [
- {
- "conditions": [
- {
- "type": "order-value",
- "min_value": 9.99,
- "max_value": 999.99,
- "include_taxes": true,
- "is_in_range": true
}
]
}
], - "target_products": [
- "026bc5f6-8373-4aeb-972e-e78d72a67121"
], - "target_sets": [
- "026bc5f6-8373-4aeb-972e-e78d72a67121"
], - "target_shipping_methods": [
- "026bc5f6-8373-4aeb-972e-e78d72a67121"
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}{- "data": {
- "name": "Black",
- "description": "Black Weekend 2021",
- "type": "amount",
- "value": "50",
- "priority": 1,
- "target_type": "order-value",
- "target_is_allow_list": true,
- "active": true,
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "condition_groups": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "conditions": [
- {
- "type": "order-value",
- "min_value": 9.99,
- "max_value": 999.99,
- "include_taxes": true,
- "is_in_range": true,
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121"
}
]
}
], - "target_products": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "slug": "white-socks",
- "name": "White socks",
- "price": 10.99,
- "price_min": 11.99,
- "price_max": 19.99,
- "price_min_initial": 12.99,
- "price_max_initial": 20.99,
- "public": true,
- "visible": true,
- "available": true,
- "quantity_step": 0.05,
- "quantity": 20,
- "google_product_category": 2271,
- "vat_rate": 23,
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11",
- "shipping_digital": true,
- "purchase_limit_per_user": 5,
- "cover": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "tags": [
- {
- "name": "Sale",
- "color": 111111
}
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "has_schemas": true
}
], - "target_sets": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "AGD",
- "slug": "agd",
- "slug_suffix": "test",
- "slug_override": true,
- "public": true,
- "visible": true,
- "parent_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "children_ids": [
- "026bc5f6-8373-4aeb-972e-e78d72a67121"
], - "cover": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "attributes": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Screen size",
- "slug": "screen-size",
- "description": "Presented number is size of screen monitor",
- "min": "22",
- "max": "27",
- "type": 1,
- "global": true,
- "sortable": true,
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "target_shipping_methods": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Next Day Courier",
- "price": 2,
- "public": true,
- "block_list": true,
- "payment_methods": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Heseya Pay",
- "alias": "heseya",
- "public": true,
- "icon": "string",
- "url": "string"
}
], - "countries": [
- {
- "code": "PL",
- "name": "Poland"
}
], - "price_ranges": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "start": 0,
- "prices": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "value": 19.97,
- "model_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "model_type": "App\\Models\\Product"
}
]
}
], - "shipping_time_min": 2,
- "shipping_time_max": 2,
- "shipping_points": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Johny Mielony",
- "address": "Gdańska 89/1",
- "vat": "9571099580",
- "zip": "80-200",
- "city": "Bydgoszcz",
- "country": "PL",
- "phone": "+48543234123"
}
], - "integration_key": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "shipping_type": "digital",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
}| id required | string Example: 026bc5f6-8373-4aeb-972e-e78d72a67121 |
{- "data": {
- "name": "Black",
- "description": "Black Weekend 2021",
- "type": "amount",
- "value": "50",
- "priority": 1,
- "target_type": "order-value",
- "target_is_allow_list": true,
- "active": true,
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "condition_groups": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "conditions": [
- {
- "type": "order-value",
- "min_value": 9.99,
- "max_value": 999.99,
- "include_taxes": true,
- "is_in_range": true,
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121"
}
]
}
], - "target_products": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "slug": "white-socks",
- "name": "White socks",
- "price": 10.99,
- "price_min": 11.99,
- "price_max": 19.99,
- "price_min_initial": 12.99,
- "price_max_initial": 20.99,
- "public": true,
- "visible": true,
- "available": true,
- "quantity_step": 0.05,
- "quantity": 20,
- "google_product_category": 2271,
- "vat_rate": 23,
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11",
- "shipping_digital": true,
- "purchase_limit_per_user": 5,
- "cover": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "tags": [
- {
- "name": "Sale",
- "color": 111111
}
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "has_schemas": true
}
], - "target_sets": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "AGD",
- "slug": "agd",
- "slug_suffix": "test",
- "slug_override": true,
- "public": true,
- "visible": true,
- "parent_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "children_ids": [
- "026bc5f6-8373-4aeb-972e-e78d72a67121"
], - "cover": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "attributes": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Screen size",
- "slug": "screen-size",
- "description": "Presented number is size of screen monitor",
- "min": "22",
- "max": "27",
- "type": 1,
- "global": true,
- "sortable": true,
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "target_shipping_methods": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Next Day Courier",
- "price": 2,
- "public": true,
- "block_list": true,
- "payment_methods": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Heseya Pay",
- "alias": "heseya",
- "public": true,
- "icon": "string",
- "url": "string"
}
], - "countries": [
- {
- "code": "PL",
- "name": "Poland"
}
], - "price_ranges": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "start": 0,
- "prices": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "value": 19.97,
- "model_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "model_type": "App\\Models\\Product"
}
]
}
], - "shipping_time_min": 2,
- "shipping_time_max": 2,
- "shipping_points": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Johny Mielony",
- "address": "Gdańska 89/1",
- "vat": "9571099580",
- "zip": "80-200",
- "city": "Bydgoszcz",
- "country": "PL",
- "phone": "+48543234123"
}
], - "integration_key": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "shipping_type": "digital",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
}| id required | string Example: 5b320ba6-d5ee-4870-bed2-1a101704c2c4 |
| name required | string |
| description | string |
| type required | string Enum: "amount" "percentage" |
| value required | number |
| priority required | number |
| target_type required | string Enum: "order-value" "products" "shipping-price" "cheapest-product" |
| target_is_allow_list required | boolean |
| active required | boolean |
Array of objects (DiscountConditions_ConditionGroup) | |
| target_products | Array of strings |
| target_sets | Array of strings |
| target_shipping_methods | Array of strings |
{- "name": "Black",
- "description": "Black Weekend 2021",
- "type": "amount",
- "value": "50",
- "priority": 1,
- "target_type": "order-value",
- "target_is_allow_list": true,
- "active": true,
- "condition_groups": [
- {
- "conditions": [
- {
- "type": "order-value",
- "min_value": 9.99,
- "max_value": 999.99,
- "include_taxes": true,
- "is_in_range": true
}
]
}
], - "target_products": [
- "026bc5f6-8373-4aeb-972e-e78d72a67121"
], - "target_sets": [
- "026bc5f6-8373-4aeb-972e-e78d72a67121"
], - "target_shipping_methods": [
- "026bc5f6-8373-4aeb-972e-e78d72a67121"
]
}{- "data": {
- "name": "Black",
- "description": "Black Weekend 2021",
- "type": "amount",
- "value": "50",
- "priority": 1,
- "target_type": "order-value",
- "target_is_allow_list": true,
- "active": true,
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "condition_groups": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "conditions": [
- {
- "type": "order-value",
- "min_value": 9.99,
- "max_value": 999.99,
- "include_taxes": true,
- "is_in_range": true,
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121"
}
]
}
], - "target_products": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "slug": "white-socks",
- "name": "White socks",
- "price": 10.99,
- "price_min": 11.99,
- "price_max": 19.99,
- "price_min_initial": 12.99,
- "price_max_initial": 20.99,
- "public": true,
- "visible": true,
- "available": true,
- "quantity_step": 0.05,
- "quantity": 20,
- "google_product_category": 2271,
- "vat_rate": 23,
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11",
- "shipping_digital": true,
- "purchase_limit_per_user": 5,
- "cover": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "tags": [
- {
- "name": "Sale",
- "color": 111111
}
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "has_schemas": true
}
], - "target_sets": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "AGD",
- "slug": "agd",
- "slug_suffix": "test",
- "slug_override": true,
- "public": true,
- "visible": true,
- "parent_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "children_ids": [
- "026bc5f6-8373-4aeb-972e-e78d72a67121"
], - "cover": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "attributes": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Screen size",
- "slug": "screen-size",
- "description": "Presented number is size of screen monitor",
- "min": "22",
- "max": "27",
- "type": 1,
- "global": true,
- "sortable": true,
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "target_shipping_methods": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Next Day Courier",
- "price": 2,
- "public": true,
- "block_list": true,
- "payment_methods": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Heseya Pay",
- "alias": "heseya",
- "public": true,
- "icon": "string",
- "url": "string"
}
], - "countries": [
- {
- "code": "PL",
- "name": "Poland"
}
], - "price_ranges": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "start": 0,
- "prices": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "value": 19.97,
- "model_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "model_type": "App\\Models\\Product"
}
]
}
], - "shipping_time_min": 2,
- "shipping_time_max": 2,
- "shipping_points": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Johny Mielony",
- "address": "Gdańska 89/1",
- "vat": "9571099580",
- "zip": "80-200",
- "city": "Bydgoszcz",
- "country": "PL",
- "phone": "+48543234123"
}
], - "integration_key": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "shipping_type": "digital",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
}| search | string |
| description | string |
| code | string |
| for_role | string |
| ids[] | string Example: ids[]=ids[]=5a61f3a1-1cd1-4e71-bf7d-0d3a159bd6b0&ids[]=33e37b2a-44e9-4d35-88db-d9a79a61e557 Ids array search |
{- "data": [
- {
- "name": "Black",
- "description": "Black Weekend 2021",
- "type": "amount",
- "value": "50",
- "priority": 1,
- "target_type": "order-value",
- "target_is_allow_list": true,
- "active": true,
- "code": "83734AE",
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "condition_groups": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "conditions": [
- {
- "type": "order-value",
- "min_value": 9.99,
- "max_value": 999.99,
- "include_taxes": true,
- "is_in_range": true,
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121"
}
]
}
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
]
}| name required | string |
| description | string |
| type required | string Enum: "amount" "percentage" |
| value required | number |
| priority required | number |
| target_type required | string Enum: "order-value" "products" "shipping-price" "cheapest-product" |
| target_is_allow_list required | boolean |
| active | boolean |
| code required | string |
Array of objects | |
| target_products | Array of strings |
| target_sets | Array of strings |
| target_shipping_methods | Array of strings |
object (Metadata) | |
object (Metadata) |
{- "name": "Black",
- "description": "Black Weekend 2021",
- "type": "amount",
- "value": "50",
- "priority": 1,
- "target_type": "order-value",
- "target_is_allow_list": true,
- "active": true,
- "code": "83734AE",
- "condition_groups": [
- {
- "conditions": [
- {
- "type": "order-value",
- "min_value": 9.99,
- "max_value": 999.99,
- "include_taxes": true,
- "is_in_range": true
}
]
}
], - "target_products": [
- "026bc5f6-8373-4aeb-972e-e78d72a67121"
], - "target_sets": [
- "026bc5f6-8373-4aeb-972e-e78d72a67121"
], - "target_shipping_methods": [
- "026bc5f6-8373-4aeb-972e-e78d72a67121"
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}{- "data": {
- "name": "Black",
- "description": "Black Weekend 2021",
- "type": "amount",
- "value": "50",
- "priority": 1,
- "target_type": "order-value",
- "target_is_allow_list": true,
- "active": true,
- "code": "83734AE",
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "condition_groups": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "conditions": [
- {
- "type": "order-value",
- "min_value": 9.99,
- "max_value": 999.99,
- "include_taxes": true,
- "is_in_range": true,
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121"
}
]
}
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
}| id required | string Example: 026bc5f6-8373-4aeb-972e-e78d72a67121 |
{- "data": {
- "name": "Black",
- "description": "Black Weekend 2021",
- "type": "amount",
- "value": "50",
- "priority": 1,
- "target_type": "order-value",
- "target_is_allow_list": true,
- "active": true,
- "code": "83734AE",
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "condition_groups": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "conditions": [
- {
- "type": "order-value",
- "min_value": 9.99,
- "max_value": 999.99,
- "include_taxes": true,
- "is_in_range": true,
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121"
}
]
}
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
}| id required | string Example: 5b320ba6-d5ee-4870-bed2-1a101704c2c4 |
| name required | string |
| description | string |
| type required | string Enum: "amount" "percentage" |
| value required | number |
| priority required | number |
| target_type required | string Enum: "order-value" "products" "shipping-price" "cheapest-product" |
| target_is_allow_list required | boolean |
| active | boolean |
| code required | string |
Array of objects (DiscountConditions_ConditionGroup) | |
| target_products | Array of strings |
| target_sets | Array of strings |
| target_shipping_methods | Array of strings |
{- "name": "Black",
- "description": "Black Weekend 2021",
- "type": "amount",
- "value": "50",
- "priority": 1,
- "target_type": "order-value",
- "target_is_allow_list": true,
- "active": true,
- "code": "83734AE",
- "condition_groups": [
- {
- "conditions": [
- {
- "type": "order-value",
- "min_value": 9.99,
- "max_value": 999.99,
- "include_taxes": true,
- "is_in_range": true
}
]
}
], - "target_products": [
- "026bc5f6-8373-4aeb-972e-e78d72a67121"
], - "target_sets": [
- "026bc5f6-8373-4aeb-972e-e78d72a67121"
], - "target_shipping_methods": [
- "026bc5f6-8373-4aeb-972e-e78d72a67121"
]
}{- "data": {
- "name": "Black",
- "description": "Black Weekend 2021",
- "type": "amount",
- "value": "50",
- "priority": 1,
- "target_type": "order-value",
- "target_is_allow_list": true,
- "active": true,
- "code": "83734AE",
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "condition_groups": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "conditions": [
- {
- "type": "order-value",
- "min_value": 9.99,
- "max_value": 999.99,
- "include_taxes": true,
- "is_in_range": true,
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121"
}
]
}
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
}{- "data": {
- "name": "Black",
- "description": "Black Weekend 2021",
- "type": "amount",
- "value": "50",
- "priority": 1,
- "target_type": "order-value",
- "target_is_allow_list": true,
- "active": true,
- "code": "83734AE",
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "condition_groups": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "conditions": [
- {
- "type": "order-value",
- "min_value": 9.99,
- "max_value": 999.99,
- "include_taxes": true,
- "is_in_range": true,
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121"
}
]
}
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
}| status | number Status code search |
| event | string Event search |
| web_hook_id | string Webhook ID search |
| successful | boolean Is successful |
{- "data": [
- {
- "id": "be1186e6-4bb4-4e36-a304-d8425b4de7fc",
- "web_hook": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "WebHook name",
- "secret": "secret",
- "with_issuer": true,
- "with_hidden": true,
- "events": [
- "OrderCreated"
], - "logs": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "triggered_at": "2021-10-07T08:49",
- "status_code": 200
}
]
}, - "triggered_at": "2021-10-07T08:49",
- "status_code": 404,
- "payload": { },
- "event": "OrderCreated",
- "response": "string"
}
]
}{- "data": [
- {
- "key": "PRODUCT_CREATED",
- "name": "Product created",
- "description": "Event triggered when new products are created",
- "required_permissions": [
- "products.show"
], - "required_hidden_permissions": [
- "products.show_hidden"
], - "encrypted": true
}
]
}| name | string Name search |
| url | string URL search |
| ids[] | string Example: ids[]=ids[]=5a61f3a1-1cd1-4e71-bf7d-0d3a159bd6b0&ids[]=33e37b2a-44e9-4d35-88db-d9a79a61e557 Ids array search |
{- "data": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "WebHook name",
- "secret": "secret",
- "with_issuer": true,
- "with_hidden": true,
- "events": [
- "OrderCreated"
], - "logs": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "triggered_at": "2021-10-07T08:49",
- "status_code": 200
}
]
}
]
}| name | string Displayed webhook name |
| url | string Displayed webhook url |
| secret | string Displayed webhook secret |
| with_issuer | boolean Whether issuer is visible in WebHookEvent. |
| with_hidden | boolean Whether hidden data are visible in WebHookEvent. |
| events | Array of strings List of WebHook events |
{- "name": "WebHook name",
- "secret": "secret",
- "with_issuer": true,
- "with_hidden": true,
- "events": [
- "OrderCreated"
]
}{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "WebHook name",
- "secret": "secret",
- "with_issuer": true,
- "with_hidden": true,
- "events": [
- "OrderCreated"
], - "logs": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "triggered_at": "2021-10-07T08:49",
- "status_code": 200
}
]
}
}| id required | string Example: 5b320ba6-d5ee-4870-bed2-1a101704c2c4 Name search |
{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "WebHook name",
- "secret": "secret",
- "with_issuer": true,
- "with_hidden": true,
- "events": [
- "OrderCreated"
], - "logs": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "triggered_at": "2021-10-07T08:49",
- "status_code": 200
}
]
}
}| id required | string Example: 5b320ba6-d5ee-4870-bed2-1a101704c2c4 |
| name | string Displayed webhook name |
| url | string Displayed webhook url |
| secret | string Displayed webhook secret |
| with_issuer | boolean Whether issuer is visible in WebHookEvent. |
| with_hidden | boolean Whether hidden data are visible in WebHookEvent. |
| events | Array of strings List of WebHook events |
{- "name": "WebHook name",
- "secret": "secret",
- "with_issuer": true,
- "with_hidden": true,
- "events": [
- "OrderCreated"
]
}{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "WebHook name",
- "secret": "secret",
- "with_issuer": true,
- "with_hidden": true,
- "events": [
- "OrderCreated"
], - "logs": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "triggered_at": "2021-10-07T08:49",
- "status_code": 200
}
]
}
}| sets[] | string Example: sets[]=sets[]=026bc5f6-8373-4aeb-972e-e78d72a67121&sets[]=026bc5f6-8373-4aeb-972e-e78d72a67121 Array of sets ids to search attributes |
{- "data": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Screen size",
- "slug": "screen-size",
- "description": "Presented number is size of screen monitor",
- "min": "22",
- "max": "27",
- "type": 1,
- "global": true,
- "sortable": true
}
]
}| search | string Full text search |
| name | string Name search |
| sku | string Sku search |
| sort | string Example: sort=name:asc,created_at:desc,updated_at:asc,sku:desc,quantity:desc Sorting string. Cannot sort by quantity if field day is present |
| sold_out | boolean Items sold out search. Cannot search by this field if field day is present |
| day | string <date | date-time> Items status as at day. If present cannot search by sold_out field and sort by quantity. If only date is provided then default time is set to 23:59:59 |
object (MetadataQuery) search by metadata | |
object (MetadataQuery) search by metadata private | |
| ids[] | string Example: ids[]=ids[]=5a61f3a1-1cd1-4e71-bf7d-0d3a159bd6b0&ids[]=33e37b2a-44e9-4d35-88db-d9a79a61e557 Ids array search |
{- "data": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Chain",
- "sku": "K121",
- "quantity": "20",
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11",
- "unlimited_shipping_time": 5,
- "unlimited_shipping_date": "2021-09-13T11:11",
- "availability": [
- {
- "quantity": "20",
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11"
}
]
}
]
}| name required | string |
| sku required | string |
| unlimited_shipping_time | integer |
| unlimited_shipping_date | string <date-time> |
object (Metadata) | |
object (Metadata) |
{- "name": "Chain",
- "sku": "K121",
- "unlimited_shipping_time": 5,
- "unlimited_shipping_date": "2021-09-13T11:11",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Chain",
- "sku": "K121",
- "quantity": "20",
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11",
- "unlimited_shipping_time": 5,
- "unlimited_shipping_date": "2021-09-13T11:11",
- "availability": [
- {
- "quantity": "20",
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11"
}
]
}
}{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Chain",
- "sku": "K121",
- "quantity": "20",
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11",
- "unlimited_shipping_time": 5,
- "unlimited_shipping_date": "2021-09-13T11:11",
- "availability": [
- {
- "quantity": "20",
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11"
}
], - "products": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "slug": "white-socks",
- "name": "White socks",
- "price": 10.99,
- "price_min": 11.99,
- "price_max": 19.99,
- "public": true,
- "visible": true,
- "available": true,
- "quantity": 20,
- "cover": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
}
], - "schemas": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "string",
- "name": "Size",
- "price": 9.99,
- "hidden": true,
- "required": true,
- "default": "string"
}
]
}
}| id required | string Example: 5b320ba6-d5ee-4870-bed2-1a101704c2c4 |
| name | string |
| sku | string |
| unlimited_shipping_time | integer |
| unlimited_shipping_date | string <date-time> |
{- "name": "Chain",
- "sku": "K121",
- "unlimited_shipping_time": 5,
- "unlimited_shipping_date": "2021-09-13T11:11"
}{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Chain",
- "sku": "K121",
- "quantity": "20",
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11",
- "unlimited_shipping_time": 5,
- "unlimited_shipping_date": "2021-09-13T11:11",
- "availability": [
- {
- "quantity": "20",
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11"
}
]
}
}| type | string Example: type=photo |
| has_relationships | boolean |
| ids[] | string Example: ids[]=ids[]=5a61f3a1-1cd1-4e71-bf7d-0d3a159bd6b0&ids[]=33e37b2a-44e9-4d35-88db-d9a79a61e557 Ids array search |
{- "data": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "relations_count": 2
}
]
}| file | string <binary> File. Accepted extensions: jpeg, png, gif, bmp, svg, mp4, webm, ogg, avi, mov, wmv |
| slug | string |
| alt | string |
| metadata.* | string asterisk has to be replaced with metadata key |
{- "data": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
]
}| id required | string |
| alt | string Media alt description |
| slug | string Media slug without domain and file extension |
{- "alt": "Example media alt description",
- "slug": "test-slug"
}{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
}| search | string Full text search. |
| sort | string Example: sort=code:asc,created_at:desc,id:asc,email:desc,summary:desc Sorting string. |
| status_id | string Status UUID |
| shipping_method_id | string Shipping Method UUID |
| digital_shipping_method_id | string Digital Shipping Method UUID |
| paid | boolean Is order paid |
| from | string <date-time> Date datetime from |
| to | string <date-time> Date datetime to |
object (MetadataQuery) search by metadata | |
object (MetadataQuery) search by metadata private | |
| ids[] | string Example: ids[]=ids[]=5a61f3a1-1cd1-4e71-bf7d-0d3a159bd6b0&ids[]=33e37b2a-44e9-4d35-88db-d9a79a61e557 Ids array search |
{- "data": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "code": "FMBZRK",
- "email": "admin@example.com",
- "payable": true,
- "currency": "PLN",
- "comment": "asap plz",
- "cart_total_initial": 38.7,
- "cart_total": 18.7,
- "shipping_price_initial": 38.7,
- "shipping_price": 18.7,
- "summary": 0,
- "summary_paid": 199.99,
- "paid": true,
- "status": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Cancel",
- "color": "8f022c",
- "cancel": true,
- "description": "Your order has been cancelled!"
}, - "shipping_method": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Next Day Courier",
- "price": 2,
- "public": true,
- "block_list": true,
- "payment_methods": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Heseya Pay",
- "alias": "heseya",
- "public": true,
- "icon": "string",
- "url": "string"
}
], - "countries": [
- {
- "code": "PL",
- "name": "Poland"
}
], - "price_ranges": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "start": 0,
- "prices": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "value": 19.97,
- "model_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "model_type": "App\\Models\\Product"
}
]
}
], - "shipping_time_min": 2,
- "shipping_time_max": 2,
- "shipping_points": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Johny Mielony",
- "address": "Gdańska 89/1",
- "vat": "9571099580",
- "zip": "80-200",
- "city": "Bydgoszcz",
- "country": "PL",
- "phone": "+48543234123"
}
], - "integration_key": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "shipping_type": "digital",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "digital_shipping_method": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Next Day Courier",
- "price": 2,
- "public": true,
- "block_list": true,
- "payment_methods": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Heseya Pay",
- "alias": "heseya",
- "public": true,
- "icon": "string",
- "url": "string"
}
], - "countries": [
- {
- "code": "PL",
- "name": "Poland"
}
], - "price_ranges": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "start": 0,
- "prices": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "value": 19.97,
- "model_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "model_type": "App\\Models\\Product"
}
]
}
], - "shipping_time_min": 2,
- "shipping_time_max": 2,
- "shipping_points": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Johny Mielony",
- "address": "Gdańska 89/1",
- "vat": "9571099580",
- "zip": "80-200",
- "city": "Bydgoszcz",
- "country": "PL",
- "phone": "+48543234123"
}
], - "integration_key": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "shipping_type": "digital",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "documents": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "invoice",
- "name": "test"
}, - "shipping_type": "address",
- "invoice_requested": true,
- "billing_address": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Johny Mielony",
- "address": "Gdańska 89/1",
- "vat": "9571099580",
- "zip": "80-200",
- "city": "Bydgoszcz",
- "country": "PL",
- "phone": "+48543234123"
}, - "shipping_place": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Johny Mielony",
- "address": "Gdańska 89/1",
- "vat": "9571099580",
- "zip": "80-200",
- "city": "Bydgoszcz",
- "country": "PL",
- "phone": "+48543234123"
}, - "created_at": "string",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
]
}| email required | string |
| comment | string |
| shipping_method_id | string |
| digital_shipping_method_id | string |
required | Array of objects |
object (Addresses_Address) | |
required | object (Addresses_Address) |
| coupons | Array of strings |
| invoice_requested | boolean |
| sale_ids | Array of strings |
object (Metadata) | |
object (Metadata) |
{- "email": "admin@example.com",
- "comment": "asap plz",
- "shipping_method_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "digital_shipping_method_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "items": [
- {
- "product_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "quantity": 0,
- "schemas": {
- "119c0a63-1ea1-4769-8d5f-169f68de5598": "123459fb-39a4-4dd0-8240-14793aa1f73b",
- "02b97693-857c-4fb9-9999-47400ac5fbef": "HE + YA"
}
}
], - "shipping_place": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Johny Mielony",
- "address": "Gdańska 89/1",
- "vat": "9571099580",
- "zip": "80-200",
- "city": "Bydgoszcz",
- "country": "PL",
- "phone": "+48543234123"
}, - "billing_address": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Johny Mielony",
- "address": "Gdańska 89/1",
- "vat": "9571099580",
- "zip": "80-200",
- "city": "Bydgoszcz",
- "country": "PL",
- "phone": "+48543234123"
}, - "coupons": [
- "8JVA0XRT"
], - "invoice_requested": true,
- "sale_ids": [
- "16277176-d819-417b-90af-8d8534995786"
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "code": "G3K4DH",
- "status": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Cancel",
- "color": "8f022c",
- "cancel": true,
- "description": "Your order has been cancelled!"
}, - "paid": true,
- "payable": true,
- "cart_total_initial": 380.7,
- "cart_total": 180.7,
- "shipping_price_initial": 38.7,
- "shipping_price": 18.7,
- "summary": 0,
- "shipping_method": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Next Day Courier",
- "price": 2,
- "public": true,
- "block_list": true,
- "payment_methods": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Heseya Pay",
- "alias": "heseya",
- "public": true,
- "icon": "string",
- "url": "string"
}
], - "countries": [
- {
- "code": "PL",
- "name": "Poland"
}
], - "price_ranges": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "start": 0,
- "prices": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "value": 19.97,
- "model_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "model_type": "App\\Models\\Product"
}
]
}
], - "shipping_time_min": 2,
- "shipping_time_max": 2,
- "shipping_points": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Johny Mielony",
- "address": "Gdańska 89/1",
- "vat": "9571099580",
- "zip": "80-200",
- "city": "Bydgoszcz",
- "country": "PL",
- "phone": "+48543234123"
}
], - "integration_key": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "shipping_type": "digital",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "digital_shipping_method": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Next Day Courier",
- "price": 2,
- "public": true,
- "block_list": true,
- "payment_methods": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Heseya Pay",
- "alias": "heseya",
- "public": true,
- "icon": "string",
- "url": "string"
}
], - "countries": [
- {
- "code": "PL",
- "name": "Poland"
}
], - "price_ranges": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "start": 0,
- "prices": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "value": 19.97,
- "model_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "model_type": "App\\Models\\Product"
}
]
}
], - "shipping_time_min": 2,
- "shipping_time_max": 2,
- "shipping_points": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Johny Mielony",
- "address": "Gdańska 89/1",
- "vat": "9571099580",
- "zip": "80-200",
- "city": "Bydgoszcz",
- "country": "PL",
- "phone": "+48543234123"
}
], - "integration_key": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "shipping_type": "digital",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "created_at": "2021-09-13T11:11",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
}| id required | string Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0 |
{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "code": "FMBZRK",
- "email": "admin@example.com",
- "payable": true,
- "currency": "PLN",
- "comment": "asap plz",
- "cart_total_initial": 38.7,
- "cart_total": 18.7,
- "shipping_price_initial": 38.7,
- "shipping_price": 18.7,
- "summary": 0,
- "summary_paid": 199.99,
- "paid": true,
- "status": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Cancel",
- "color": "8f022c",
- "cancel": true,
- "description": "Your order has been cancelled!"
}, - "shipping_method": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Next Day Courier",
- "price": 2,
- "public": true,
- "block_list": true,
- "payment_methods": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Heseya Pay",
- "alias": "heseya",
- "public": true,
- "icon": "string",
- "url": "string"
}
], - "countries": [
- {
- "code": "PL",
- "name": "Poland"
}
], - "price_ranges": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "start": 0,
- "prices": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "value": 19.97,
- "model_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "model_type": "App\\Models\\Product"
}
]
}
], - "shipping_time_min": 2,
- "shipping_time_max": 2,
- "shipping_points": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Johny Mielony",
- "address": "Gdańska 89/1",
- "vat": "9571099580",
- "zip": "80-200",
- "city": "Bydgoszcz",
- "country": "PL",
- "phone": "+48543234123"
}
], - "integration_key": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "shipping_type": "digital",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "digital_shipping_method": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Next Day Courier",
- "price": 2,
- "public": true,
- "block_list": true,
- "payment_methods": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Heseya Pay",
- "alias": "heseya",
- "public": true,
- "icon": "string",
- "url": "string"
}
], - "countries": [
- {
- "code": "PL",
- "name": "Poland"
}
], - "price_ranges": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "start": 0,
- "prices": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "value": 19.97,
- "model_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "model_type": "App\\Models\\Product"
}
]
}
], - "shipping_time_min": 2,
- "shipping_time_max": 2,
- "shipping_points": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Johny Mielony",
- "address": "Gdańska 89/1",
- "vat": "9571099580",
- "zip": "80-200",
- "city": "Bydgoszcz",
- "country": "PL",
- "phone": "+48543234123"
}
], - "integration_key": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "shipping_type": "digital",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "documents": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "invoice",
- "name": "test"
}, - "shipping_type": "address",
- "invoice_requested": true,
- "billing_address": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Johny Mielony",
- "address": "Gdańska 89/1",
- "vat": "9571099580",
- "zip": "80-200",
- "city": "Bydgoszcz",
- "country": "PL",
- "phone": "+48543234123"
}, - "shipping_place": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Johny Mielony",
- "address": "Gdańska 89/1",
- "vat": "9571099580",
- "zip": "80-200",
- "city": "Bydgoszcz",
- "country": "PL",
- "phone": "+48543234123"
}, - "created_at": "string",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "products": [
- {
- "quantity": "12.4",
- "price": "199.99",
- "price_initial": "299.99",
- "schemas": [
- {
- "name": "Size",
- "value": "XL",
- "price": "49.99",
- "price_initial": "59.99"
}
], - "deposits": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "quantity": "12.5",
- "item_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "order_product_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11",
- "from_unlimited": true
}
], - "discounts": [
- {
- "discount": {
- "name": "Black",
- "description": "Black Weekend 2021",
- "type": "amount",
- "value": "50",
- "priority": 1,
- "target_type": "order-value",
- "target_is_allow_list": true,
- "active": true,
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "condition_groups": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "conditions": [
- null
]
}
], - "target_products": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "slug": "white-socks",
- "name": "White socks",
- "price": 10.99,
- "price_min": 11.99,
- "price_max": 19.99,
- "price_min_initial": 12.99,
- "price_max_initial": 20.99,
- "public": true,
- "visible": true,
- "available": true,
- "quantity_step": 0.05,
- "quantity": 20,
- "google_product_category": 2271,
- "vat_rate": 23,
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11",
- "shipping_digital": true,
- "purchase_limit_per_user": 5,
- "cover": {
- "id": null,
- "type": null,
- "url": null,
- "alt": null,
- "slug": null,
- "metadata": null,
- "metadata_private": null
}, - "tags": [
- null
], - "metadata": {
- "invoice": null,
- "erp_id": null,
- "synced": null
}, - "metadata_private": {
- "invoice": null,
- "erp_id": null,
- "synced": null
}, - "has_schemas": true
}
], - "target_sets": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "AGD",
- "slug": "agd",
- "slug_suffix": "test",
- "slug_override": true,
- "public": true,
- "visible": true,
- "parent_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "children_ids": [
- null
], - "cover": {
- "id": null,
- "type": null,
- "url": null,
- "alt": null,
- "slug": null,
- "metadata": null,
- "metadata_private": null
}, - "attributes": [
- null
], - "metadata": {
- "invoice": null,
- "erp_id": null,
- "synced": null
}, - "metadata_private": {
- "invoice": null,
- "erp_id": null,
- "synced": null
}
}
], - "target_shipping_methods": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Next Day Courier",
- "price": 2,
- "public": true,
- "block_list": true,
- "payment_methods": [
- null
], - "countries": [
- null
], - "price_ranges": [
- null
], - "shipping_time_min": 2,
- "shipping_time_max": 2,
- "shipping_points": [
- null
], - "integration_key": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "shipping_type": "digital",
- "metadata": {
- "invoice": null,
- "erp_id": null,
- "synced": null
}, - "metadata_private": {
- "invoice": null,
- "erp_id": null,
- "synced": null
}
}
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "name": "Black Week",
- "code": "BLACK22",
- "type": "amount",
- "target_type": "order-value",
- "value": 9.99,
- "applied_discount": 9.99
}
], - "shipping_digital": true,
- "is_delivered": true,
- "urls": [
]
}
], - "payments": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "external_id": "D2spSDJ21LSA",
- "method_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "amount": 80.92,
- "status": "pending",
- "date": "2022-05-04T12:14:45.000000Z"
}
], - "shipping_number": "630552359128340015809770",
- "buyer": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "email": "email@example.com",
- "name": "Johny Mielony",
- "avatar": "//www.gravatar.com/avatar/example.jpg",
- "roles": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Admin",
- "description": "Role with permission to everything",
- "assignable": true,
- "deletable": true,
- "users_count": 10,
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "consents": [
- {
- "name": "Consent One",
- "description_html": "<h1>Lorem ipsum dolor sit amet</h1>",
- "required": true,
- "value": true
}
], - "birthdate_date": "2000-01-01",
- "phone": "+48123456789",
- "phone_country": "PL",
- "phone_number": "12 345 67 89",
- "created_at": "2022-12-06T09:11",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "permissions": [
- "roles.show_details"
], - "preferences": {
- "successful_login_attempt_alert": true,
- "failed_login_attempt_alert": true,
- "new_localization_login_alert": true,
- "recovery_code_changed_alert": true
}
}, - "discounts": [
- {
- "discount": {
- "name": "Black",
- "description": "Black Weekend 2021",
- "type": "amount",
- "value": "50",
- "priority": 1,
- "target_type": "order-value",
- "target_is_allow_list": true,
- "active": true,
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "condition_groups": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "conditions": [
- {
- "type": "order-value",
- "min_value": 9.99,
- "max_value": 999.99,
- "include_taxes": true,
- "is_in_range": true,
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121"
}
]
}
], - "target_products": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "slug": "white-socks",
- "name": "White socks",
- "price": 10.99,
- "price_min": 11.99,
- "price_max": 19.99,
- "price_min_initial": 12.99,
- "price_max_initial": 20.99,
- "public": true,
- "visible": true,
- "available": true,
- "quantity_step": 0.05,
- "quantity": 20,
- "google_product_category": 2271,
- "vat_rate": 23,
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11",
- "shipping_digital": true,
- "purchase_limit_per_user": 5,
- "cover": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "tags": [
- {
- "name": "Sale",
- "color": 111111
}
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "has_schemas": true
}
], - "target_sets": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "AGD",
- "slug": "agd",
- "slug_suffix": "test",
- "slug_override": true,
- "public": true,
- "visible": true,
- "parent_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "children_ids": [
- "026bc5f6-8373-4aeb-972e-e78d72a67121"
], - "cover": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "attributes": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Screen size",
- "slug": "screen-size",
- "description": "Presented number is size of screen monitor",
- "min": "22",
- "max": "27",
- "type": 1,
- "global": true,
- "sortable": true,
- "metadata": {
- "invoice": null,
- "erp_id": null,
- "synced": null
}, - "metadata_private": {
- "invoice": null,
- "erp_id": null,
- "synced": null
}
}
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "target_shipping_methods": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Next Day Courier",
- "price": 2,
- "public": true,
- "block_list": true,
- "payment_methods": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Heseya Pay",
- "alias": "heseya",
- "public": true,
- "icon": "string",
- "url": "string"
}
], - "countries": [
- {
- "code": "PL",
- "name": "Poland"
}
], - "price_ranges": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "start": 0,
- "prices": [
- null
]
}
], - "shipping_time_min": 2,
- "shipping_time_max": 2,
- "shipping_points": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Johny Mielony",
- "address": "Gdańska 89/1",
- "vat": "9571099580",
- "zip": "80-200",
- "city": "Bydgoszcz",
- "country": "PL",
- "phone": "+48543234123"
}
], - "integration_key": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "shipping_type": "digital",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "name": "Black Week",
- "code": "BLACK22",
- "type": "amount",
- "target_type": "order-value",
- "value": 9.99,
- "applied_discount": 9.99
}
]
}
}| id required | string Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0 |
string | |
| comment | string |
| shipping_number | string |
| shipping_method_id | string |
| digital_shipping_method_id | string |
object (Addresses_Address) | |
object (Addresses_Address) | |
| invoice_requested | boolean |
{- "email": "admin@example.com",
- "comment": "asap plz",
- "shipping_number": "630552359128340015809770",
- "shipping_method_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "digital_shipping_method_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "shipping_place": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Johny Mielony",
- "address": "Gdańska 89/1",
- "vat": "9571099580",
- "zip": "80-200",
- "city": "Bydgoszcz",
- "country": "PL",
- "phone": "+48543234123"
}, - "billing_address": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Johny Mielony",
- "address": "Gdańska 89/1",
- "vat": "9571099580",
- "zip": "80-200",
- "city": "Bydgoszcz",
- "country": "PL",
- "phone": "+48543234123"
}, - "invoice_requested": true
}{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "code": "FMBZRK",
- "email": "admin@example.com",
- "payable": true,
- "currency": "PLN",
- "comment": "asap plz",
- "cart_total_initial": 38.7,
- "cart_total": 18.7,
- "shipping_price_initial": 38.7,
- "shipping_price": 18.7,
- "summary": 0,
- "summary_paid": 199.99,
- "paid": true,
- "status": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Cancel",
- "color": "8f022c",
- "cancel": true,
- "description": "Your order has been cancelled!"
}, - "shipping_method": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Next Day Courier",
- "price": 2,
- "public": true,
- "block_list": true,
- "payment_methods": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Heseya Pay",
- "alias": "heseya",
- "public": true,
- "icon": "string",
- "url": "string"
}
], - "countries": [
- {
- "code": "PL",
- "name": "Poland"
}
], - "price_ranges": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "start": 0,
- "prices": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "value": 19.97,
- "model_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "model_type": "App\\Models\\Product"
}
]
}
], - "shipping_time_min": 2,
- "shipping_time_max": 2,
- "shipping_points": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Johny Mielony",
- "address": "Gdańska 89/1",
- "vat": "9571099580",
- "zip": "80-200",
- "city": "Bydgoszcz",
- "country": "PL",
- "phone": "+48543234123"
}
], - "integration_key": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "shipping_type": "digital",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "digital_shipping_method": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Next Day Courier",
- "price": 2,
- "public": true,
- "block_list": true,
- "payment_methods": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Heseya Pay",
- "alias": "heseya",
- "public": true,
- "icon": "string",
- "url": "string"
}
], - "countries": [
- {
- "code": "PL",
- "name": "Poland"
}
], - "price_ranges": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "start": 0,
- "prices": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "value": 19.97,
- "model_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "model_type": "App\\Models\\Product"
}
]
}
], - "shipping_time_min": 2,
- "shipping_time_max": 2,
- "shipping_points": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Johny Mielony",
- "address": "Gdańska 89/1",
- "vat": "9571099580",
- "zip": "80-200",
- "city": "Bydgoszcz",
- "country": "PL",
- "phone": "+48543234123"
}
], - "integration_key": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "shipping_type": "digital",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "documents": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "invoice",
- "name": "test"
}, - "shipping_type": "address",
- "invoice_requested": true,
- "billing_address": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Johny Mielony",
- "address": "Gdańska 89/1",
- "vat": "9571099580",
- "zip": "80-200",
- "city": "Bydgoszcz",
- "country": "PL",
- "phone": "+48543234123"
}, - "shipping_place": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Johny Mielony",
- "address": "Gdańska 89/1",
- "vat": "9571099580",
- "zip": "80-200",
- "city": "Bydgoszcz",
- "country": "PL",
- "phone": "+48543234123"
}, - "created_at": "string",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "products": [
- {
- "quantity": "12.4",
- "price": "199.99",
- "price_initial": "299.99",
- "schemas": [
- {
- "name": "Size",
- "value": "XL",
- "price": "49.99",
- "price_initial": "59.99"
}
], - "deposits": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "quantity": "12.5",
- "item_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "order_product_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11",
- "from_unlimited": true
}
], - "discounts": [
- {
- "discount": {
- "name": "Black",
- "description": "Black Weekend 2021",
- "type": "amount",
- "value": "50",
- "priority": 1,
- "target_type": "order-value",
- "target_is_allow_list": true,
- "active": true,
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "condition_groups": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "conditions": [
- null
]
}
], - "target_products": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "slug": "white-socks",
- "name": "White socks",
- "price": 10.99,
- "price_min": 11.99,
- "price_max": 19.99,
- "price_min_initial": 12.99,
- "price_max_initial": 20.99,
- "public": true,
- "visible": true,
- "available": true,
- "quantity_step": 0.05,
- "quantity": 20,
- "google_product_category": 2271,
- "vat_rate": 23,
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11",
- "shipping_digital": true,
- "purchase_limit_per_user": 5,
- "cover": {
- "id": null,
- "type": null,
- "url": null,
- "alt": null,
- "slug": null,
- "metadata": null,
- "metadata_private": null
}, - "tags": [
- null
], - "metadata": {
- "invoice": null,
- "erp_id": null,
- "synced": null
}, - "metadata_private": {
- "invoice": null,
- "erp_id": null,
- "synced": null
}, - "has_schemas": true
}
], - "target_sets": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "AGD",
- "slug": "agd",
- "slug_suffix": "test",
- "slug_override": true,
- "public": true,
- "visible": true,
- "parent_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "children_ids": [
- null
], - "cover": {
- "id": null,
- "type": null,
- "url": null,
- "alt": null,
- "slug": null,
- "metadata": null,
- "metadata_private": null
}, - "attributes": [
- null
], - "metadata": {
- "invoice": null,
- "erp_id": null,
- "synced": null
}, - "metadata_private": {
- "invoice": null,
- "erp_id": null,
- "synced": null
}
}
], - "target_shipping_methods": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Next Day Courier",
- "price": 2,
- "public": true,
- "block_list": true,
- "payment_methods": [
- null
], - "countries": [
- null
], - "price_ranges": [
- null
], - "shipping_time_min": 2,
- "shipping_time_max": 2,
- "shipping_points": [
- null
], - "integration_key": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "shipping_type": "digital",
- "metadata": {
- "invoice": null,
- "erp_id": null,
- "synced": null
}, - "metadata_private": {
- "invoice": null,
- "erp_id": null,
- "synced": null
}
}
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "name": "Black Week",
- "code": "BLACK22",
- "type": "amount",
- "target_type": "order-value",
- "value": 9.99,
- "applied_discount": 9.99
}
], - "shipping_digital": true,
- "is_delivered": true,
- "urls": [
]
}
], - "payments": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "external_id": "D2spSDJ21LSA",
- "method_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "amount": 80.92,
- "status": "pending",
- "date": "2022-05-04T12:14:45.000000Z"
}
], - "shipping_number": "630552359128340015809770",
- "buyer": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "email": "email@example.com",
- "name": "Johny Mielony",
- "avatar": "//www.gravatar.com/avatar/example.jpg",
- "roles": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Admin",
- "description": "Role with permission to everything",
- "assignable": true,
- "deletable": true,
- "users_count": 10,
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "consents": [
- {
- "name": "Consent One",
- "description_html": "<h1>Lorem ipsum dolor sit amet</h1>",
- "required": true,
- "value": true
}
], - "birthdate_date": "2000-01-01",
- "phone": "+48123456789",
- "phone_country": "PL",
- "phone_number": "12 345 67 89",
- "created_at": "2022-12-06T09:11",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "permissions": [
- "roles.show_details"
], - "preferences": {
- "successful_login_attempt_alert": true,
- "failed_login_attempt_alert": true,
- "new_localization_login_alert": true,
- "recovery_code_changed_alert": true
}
}, - "discounts": [
- {
- "discount": {
- "name": "Black",
- "description": "Black Weekend 2021",
- "type": "amount",
- "value": "50",
- "priority": 1,
- "target_type": "order-value",
- "target_is_allow_list": true,
- "active": true,
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "condition_groups": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "conditions": [
- {
- "type": "order-value",
- "min_value": 9.99,
- "max_value": 999.99,
- "include_taxes": true,
- "is_in_range": true,
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121"
}
]
}
], - "target_products": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "slug": "white-socks",
- "name": "White socks",
- "price": 10.99,
- "price_min": 11.99,
- "price_max": 19.99,
- "price_min_initial": 12.99,
- "price_max_initial": 20.99,
- "public": true,
- "visible": true,
- "available": true,
- "quantity_step": 0.05,
- "quantity": 20,
- "google_product_category": 2271,
- "vat_rate": 23,
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11",
- "shipping_digital": true,
- "purchase_limit_per_user": 5,
- "cover": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "tags": [
- {
- "name": "Sale",
- "color": 111111
}
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "has_schemas": true
}
], - "target_sets": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "AGD",
- "slug": "agd",
- "slug_suffix": "test",
- "slug_override": true,
- "public": true,
- "visible": true,
- "parent_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "children_ids": [
- "026bc5f6-8373-4aeb-972e-e78d72a67121"
], - "cover": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "attributes": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Screen size",
- "slug": "screen-size",
- "description": "Presented number is size of screen monitor",
- "min": "22",
- "max": "27",
- "type": 1,
- "global": true,
- "sortable": true,
- "metadata": {
- "invoice": null,
- "erp_id": null,
- "synced": null
}, - "metadata_private": {
- "invoice": null,
- "erp_id": null,
- "synced": null
}
}
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "target_shipping_methods": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Next Day Courier",
- "price": 2,
- "public": true,
- "block_list": true,
- "payment_methods": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Heseya Pay",
- "alias": "heseya",
- "public": true,
- "icon": "string",
- "url": "string"
}
], - "countries": [
- {
- "code": "PL",
- "name": "Poland"
}
], - "price_ranges": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "start": 0,
- "prices": [
- null
]
}
], - "shipping_time_min": 2,
- "shipping_time_max": 2,
- "shipping_points": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Johny Mielony",
- "address": "Gdańska 89/1",
- "vat": "9571099580",
- "zip": "80-200",
- "city": "Bydgoszcz",
- "country": "PL",
- "phone": "+48543234123"
}
], - "integration_key": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "shipping_type": "digital",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "name": "Black Week",
- "code": "BLACK22",
- "type": "amount",
- "target_type": "order-value",
- "value": 9.99,
- "applied_discount": 9.99
}
]
}
}| code required | string Example: D3PT88 |
{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "code": "G3K4DH",
- "status": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Cancel",
- "color": "8f022c",
- "cancel": true,
- "description": "Your order has been cancelled!"
}, - "paid": true,
- "payable": true,
- "cart_total_initial": 380.7,
- "cart_total": 180.7,
- "shipping_price_initial": 38.7,
- "shipping_price": 18.7,
- "summary": 0,
- "shipping_method": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Next Day Courier",
- "price": 2,
- "public": true,
- "block_list": true,
- "payment_methods": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Heseya Pay",
- "alias": "heseya",
- "public": true,
- "icon": "string",
- "url": "string"
}
], - "countries": [
- {
- "code": "PL",
- "name": "Poland"
}
], - "price_ranges": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "start": 0,
- "prices": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "value": 19.97,
- "model_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "model_type": "App\\Models\\Product"
}
]
}
], - "shipping_time_min": 2,
- "shipping_time_max": 2,
- "shipping_points": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Johny Mielony",
- "address": "Gdańska 89/1",
- "vat": "9571099580",
- "zip": "80-200",
- "city": "Bydgoszcz",
- "country": "PL",
- "phone": "+48543234123"
}
], - "integration_key": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "shipping_type": "digital",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "digital_shipping_method": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Next Day Courier",
- "price": 2,
- "public": true,
- "block_list": true,
- "payment_methods": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Heseya Pay",
- "alias": "heseya",
- "public": true,
- "icon": "string",
- "url": "string"
}
], - "countries": [
- {
- "code": "PL",
- "name": "Poland"
}
], - "price_ranges": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "start": 0,
- "prices": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "value": 19.97,
- "model_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "model_type": "App\\Models\\Product"
}
]
}
], - "shipping_time_min": 2,
- "shipping_time_max": 2,
- "shipping_points": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Johny Mielony",
- "address": "Gdańska 89/1",
- "vat": "9571099580",
- "zip": "80-200",
- "city": "Bydgoszcz",
- "country": "PL",
- "phone": "+48543234123"
}
], - "integration_key": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "shipping_type": "digital",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "created_at": "2021-09-13T11:11",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
}| id required | string Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0 |
| package_template_id | string |
{- "package_template_id": "1c8705ce-5fae-4468-b88a-8784cb5414a0"
}{- "data": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "code": "FMBZRK",
- "email": "admin@example.com",
- "payable": true,
- "currency": "PLN",
- "comment": "asap plz",
- "cart_total_initial": 38.7,
- "cart_total": 18.7,
- "shipping_price_initial": 38.7,
- "shipping_price": 18.7,
- "summary": 0,
- "summary_paid": 199.99,
- "paid": true,
- "status": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Cancel",
- "color": "8f022c",
- "cancel": true,
- "description": "Your order has been cancelled!"
}, - "shipping_method": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Next Day Courier",
- "price": 2,
- "public": true,
- "block_list": true,
- "payment_methods": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Heseya Pay",
- "alias": "heseya",
- "public": true,
- "icon": "string",
- "url": "string"
}
], - "countries": [
- {
- "code": "PL",
- "name": "Poland"
}
], - "price_ranges": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "start": 0,
- "prices": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "value": 19.97,
- "model_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "model_type": "App\\Models\\Product"
}
]
}
], - "shipping_time_min": 2,
- "shipping_time_max": 2,
- "shipping_points": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Johny Mielony",
- "address": "Gdańska 89/1",
- "vat": "9571099580",
- "zip": "80-200",
- "city": "Bydgoszcz",
- "country": "PL",
- "phone": "+48543234123"
}
], - "integration_key": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "shipping_type": "digital",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "digital_shipping_method": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Next Day Courier",
- "price": 2,
- "public": true,
- "block_list": true,
- "payment_methods": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Heseya Pay",
- "alias": "heseya",
- "public": true,
- "icon": "string",
- "url": "string"
}
], - "countries": [
- {
- "code": "PL",
- "name": "Poland"
}
], - "price_ranges": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "start": 0,
- "prices": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "value": 19.97,
- "model_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "model_type": "App\\Models\\Product"
}
]
}
], - "shipping_time_min": 2,
- "shipping_time_max": 2,
- "shipping_points": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Johny Mielony",
- "address": "Gdańska 89/1",
- "vat": "9571099580",
- "zip": "80-200",
- "city": "Bydgoszcz",
- "country": "PL",
- "phone": "+48543234123"
}
], - "integration_key": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "shipping_type": "digital",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "documents": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "invoice",
- "name": "test"
}, - "shipping_type": "address",
- "invoice_requested": true,
- "billing_address": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Johny Mielony",
- "address": "Gdańska 89/1",
- "vat": "9571099580",
- "zip": "80-200",
- "city": "Bydgoszcz",
- "country": "PL",
- "phone": "+48543234123"
}, - "shipping_place": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Johny Mielony",
- "address": "Gdańska 89/1",
- "vat": "9571099580",
- "zip": "80-200",
- "city": "Bydgoszcz",
- "country": "PL",
- "phone": "+48543234123"
}, - "created_at": "string",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
]
}| search | string Full text search. |
| sort | string Example: sort=code:asc,created_at:desc,id:asc,email:desc,summary:desc Sorting string. |
| status_id | string Status UUID |
| shipping_method_id | string Shipping Method UUID |
| from | string <date-time> Date datetime from |
| to | string <date-time> Date datetime to |
{- "data": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "code": "FMBZRK",
- "email": "admin@example.com",
- "payable": true,
- "currency": "PLN",
- "comment": "asap plz",
- "cart_total_initial": 38.7,
- "cart_total": 18.7,
- "shipping_price_initial": 38.7,
- "shipping_price": 18.7,
- "summary": 0,
- "summary_paid": 199.99,
- "paid": true,
- "status": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Cancel",
- "color": "8f022c",
- "cancel": true,
- "description": "Your order has been cancelled!"
}, - "shipping_method": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Next Day Courier",
- "price": 2,
- "public": true,
- "block_list": true,
- "payment_methods": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Heseya Pay",
- "alias": "heseya",
- "public": true,
- "icon": "string",
- "url": "string"
}
], - "countries": [
- {
- "code": "PL",
- "name": "Poland"
}
], - "price_ranges": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "start": 0,
- "prices": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "value": 19.97,
- "model_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "model_type": "App\\Models\\Product"
}
]
}
], - "shipping_time_min": 2,
- "shipping_time_max": 2,
- "shipping_points": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Johny Mielony",
- "address": "Gdańska 89/1",
- "vat": "9571099580",
- "zip": "80-200",
- "city": "Bydgoszcz",
- "country": "PL",
- "phone": "+48543234123"
}
], - "integration_key": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "shipping_type": "digital",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "digital_shipping_method": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Next Day Courier",
- "price": 2,
- "public": true,
- "block_list": true,
- "payment_methods": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Heseya Pay",
- "alias": "heseya",
- "public": true,
- "icon": "string",
- "url": "string"
}
], - "countries": [
- {
- "code": "PL",
- "name": "Poland"
}
], - "price_ranges": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "start": 0,
- "prices": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "value": 19.97,
- "model_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "model_type": "App\\Models\\Product"
}
]
}
], - "shipping_time_min": 2,
- "shipping_time_max": 2,
- "shipping_points": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Johny Mielony",
- "address": "Gdańska 89/1",
- "vat": "9571099580",
- "zip": "80-200",
- "city": "Bydgoszcz",
- "country": "PL",
- "phone": "+48543234123"
}
], - "integration_key": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "shipping_type": "digital",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "documents": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "invoice",
- "name": "test"
}, - "shipping_type": "address",
- "invoice_requested": true,
- "billing_address": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Johny Mielony",
- "address": "Gdańska 89/1",
- "vat": "9571099580",
- "zip": "80-200",
- "city": "Bydgoszcz",
- "country": "PL",
- "phone": "+48543234123"
}, - "shipping_place": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Johny Mielony",
- "address": "Gdańska 89/1",
- "vat": "9571099580",
- "zip": "80-200",
- "city": "Bydgoszcz",
- "country": "PL",
- "phone": "+48543234123"
}, - "created_at": "string",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
]
}{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "code": "FMBZRK",
- "email": "admin@example.com",
- "payable": true,
- "currency": "PLN",
- "comment": "asap plz",
- "cart_total_initial": 38.7,
- "cart_total": 18.7,
- "shipping_price_initial": 38.7,
- "shipping_price": 18.7,
- "summary": 0,
- "summary_paid": 199.99,
- "paid": true,
- "status": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Cancel",
- "color": "8f022c",
- "cancel": true,
- "description": "Your order has been cancelled!"
}, - "shipping_method": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Next Day Courier",
- "price": 2,
- "public": true,
- "block_list": true,
- "payment_methods": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Heseya Pay",
- "alias": "heseya",
- "public": true,
- "icon": "string",
- "url": "string"
}
], - "countries": [
- {
- "code": "PL",
- "name": "Poland"
}
], - "price_ranges": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "start": 0,
- "prices": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "value": 19.97,
- "model_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "model_type": "App\\Models\\Product"
}
]
}
], - "shipping_time_min": 2,
- "shipping_time_max": 2,
- "shipping_points": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Johny Mielony",
- "address": "Gdańska 89/1",
- "vat": "9571099580",
- "zip": "80-200",
- "city": "Bydgoszcz",
- "country": "PL",
- "phone": "+48543234123"
}
], - "integration_key": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "shipping_type": "digital",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "digital_shipping_method": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Next Day Courier",
- "price": 2,
- "public": true,
- "block_list": true,
- "payment_methods": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Heseya Pay",
- "alias": "heseya",
- "public": true,
- "icon": "string",
- "url": "string"
}
], - "countries": [
- {
- "code": "PL",
- "name": "Poland"
}
], - "price_ranges": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "start": 0,
- "prices": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "value": 19.97,
- "model_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "model_type": "App\\Models\\Product"
}
]
}
], - "shipping_time_min": 2,
- "shipping_time_max": 2,
- "shipping_points": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Johny Mielony",
- "address": "Gdańska 89/1",
- "vat": "9571099580",
- "zip": "80-200",
- "city": "Bydgoszcz",
- "country": "PL",
- "phone": "+48543234123"
}
], - "integration_key": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "shipping_type": "digital",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "documents": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "invoice",
- "name": "test"
}, - "shipping_type": "address",
- "invoice_requested": true,
- "billing_address": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Johny Mielony",
- "address": "Gdańska 89/1",
- "vat": "9571099580",
- "zip": "80-200",
- "city": "Bydgoszcz",
- "country": "PL",
- "phone": "+48543234123"
}, - "shipping_place": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Johny Mielony",
- "address": "Gdańska 89/1",
- "vat": "9571099580",
- "zip": "80-200",
- "city": "Bydgoszcz",
- "country": "PL",
- "phone": "+48543234123"
}, - "created_at": "string",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "products": [
- {
- "quantity": "12.4",
- "price": "199.99",
- "price_initial": "299.99",
- "schemas": [
- {
- "name": "Size",
- "value": "XL",
- "price": "49.99",
- "price_initial": "59.99"
}
], - "deposits": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "quantity": "12.5",
- "item_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "order_product_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11",
- "from_unlimited": true
}
], - "discounts": [
- {
- "discount": {
- "name": "Black",
- "description": "Black Weekend 2021",
- "type": "amount",
- "value": "50",
- "priority": 1,
- "target_type": "order-value",
- "target_is_allow_list": true,
- "active": true,
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "condition_groups": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "conditions": [
- null
]
}
], - "target_products": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "slug": "white-socks",
- "name": "White socks",
- "price": 10.99,
- "price_min": 11.99,
- "price_max": 19.99,
- "price_min_initial": 12.99,
- "price_max_initial": 20.99,
- "public": true,
- "visible": true,
- "available": true,
- "quantity_step": 0.05,
- "quantity": 20,
- "google_product_category": 2271,
- "vat_rate": 23,
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11",
- "shipping_digital": true,
- "purchase_limit_per_user": 5,
- "cover": {
- "id": null,
- "type": null,
- "url": null,
- "alt": null,
- "slug": null,
- "metadata": null,
- "metadata_private": null
}, - "tags": [
- null
], - "metadata": {
- "invoice": null,
- "erp_id": null,
- "synced": null
}, - "metadata_private": {
- "invoice": null,
- "erp_id": null,
- "synced": null
}, - "has_schemas": true
}
], - "target_sets": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "AGD",
- "slug": "agd",
- "slug_suffix": "test",
- "slug_override": true,
- "public": true,
- "visible": true,
- "parent_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "children_ids": [
- null
], - "cover": {
- "id": null,
- "type": null,
- "url": null,
- "alt": null,
- "slug": null,
- "metadata": null,
- "metadata_private": null
}, - "attributes": [
- null
], - "metadata": {
- "invoice": null,
- "erp_id": null,
- "synced": null
}, - "metadata_private": {
- "invoice": null,
- "erp_id": null,
- "synced": null
}
}
], - "target_shipping_methods": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Next Day Courier",
- "price": 2,
- "public": true,
- "block_list": true,
- "payment_methods": [
- null
], - "countries": [
- null
], - "price_ranges": [
- null
], - "shipping_time_min": 2,
- "shipping_time_max": 2,
- "shipping_points": [
- null
], - "integration_key": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "shipping_type": "digital",
- "metadata": {
- "invoice": null,
- "erp_id": null,
- "synced": null
}, - "metadata_private": {
- "invoice": null,
- "erp_id": null,
- "synced": null
}
}
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "name": "Black Week",
- "code": "BLACK22",
- "type": "amount",
- "target_type": "order-value",
- "value": 9.99,
- "applied_discount": 9.99
}
], - "shipping_digital": true,
- "is_delivered": true,
- "urls": [
]
}
], - "payments": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "external_id": "D2spSDJ21LSA",
- "method_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "amount": 80.92,
- "status": "pending",
- "date": "2022-05-04T12:14:45.000000Z"
}
], - "shipping_number": "630552359128340015809770",
- "buyer": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "email": "email@example.com",
- "name": "Johny Mielony",
- "avatar": "//www.gravatar.com/avatar/example.jpg",
- "roles": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Admin",
- "description": "Role with permission to everything",
- "assignable": true,
- "deletable": true,
- "users_count": 10,
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "consents": [
- {
- "name": "Consent One",
- "description_html": "<h1>Lorem ipsum dolor sit amet</h1>",
- "required": true,
- "value": true
}
], - "birthdate_date": "2000-01-01",
- "phone": "+48123456789",
- "phone_country": "PL",
- "phone_number": "12 345 67 89",
- "created_at": "2022-12-06T09:11",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "permissions": [
- "roles.show_details"
], - "preferences": {
- "successful_login_attempt_alert": true,
- "failed_login_attempt_alert": true,
- "new_localization_login_alert": true,
- "recovery_code_changed_alert": true
}
}, - "discounts": [
- {
- "discount": {
- "name": "Black",
- "description": "Black Weekend 2021",
- "type": "amount",
- "value": "50",
- "priority": 1,
- "target_type": "order-value",
- "target_is_allow_list": true,
- "active": true,
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "condition_groups": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "conditions": [
- {
- "type": "order-value",
- "min_value": 9.99,
- "max_value": 999.99,
- "include_taxes": true,
- "is_in_range": true,
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121"
}
]
}
], - "target_products": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "slug": "white-socks",
- "name": "White socks",
- "price": 10.99,
- "price_min": 11.99,
- "price_max": 19.99,
- "price_min_initial": 12.99,
- "price_max_initial": 20.99,
- "public": true,
- "visible": true,
- "available": true,
- "quantity_step": 0.05,
- "quantity": 20,
- "google_product_category": 2271,
- "vat_rate": 23,
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11",
- "shipping_digital": true,
- "purchase_limit_per_user": 5,
- "cover": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "tags": [
- {
- "name": "Sale",
- "color": 111111
}
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "has_schemas": true
}
], - "target_sets": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "AGD",
- "slug": "agd",
- "slug_suffix": "test",
- "slug_override": true,
- "public": true,
- "visible": true,
- "parent_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "children_ids": [
- "026bc5f6-8373-4aeb-972e-e78d72a67121"
], - "cover": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "attributes": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Screen size",
- "slug": "screen-size",
- "description": "Presented number is size of screen monitor",
- "min": "22",
- "max": "27",
- "type": 1,
- "global": true,
- "sortable": true,
- "metadata": {
- "invoice": null,
- "erp_id": null,
- "synced": null
}, - "metadata_private": {
- "invoice": null,
- "erp_id": null,
- "synced": null
}
}
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "target_shipping_methods": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Next Day Courier",
- "price": 2,
- "public": true,
- "block_list": true,
- "payment_methods": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Heseya Pay",
- "alias": "heseya",
- "public": true,
- "icon": "string",
- "url": "string"
}
], - "countries": [
- {
- "code": "PL",
- "name": "Poland"
}
], - "price_ranges": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "start": 0,
- "prices": [
- null
]
}
], - "shipping_time_min": 2,
- "shipping_time_max": 2,
- "shipping_points": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Johny Mielony",
- "address": "Gdańska 89/1",
- "vat": "9571099580",
- "zip": "80-200",
- "city": "Bydgoszcz",
- "country": "PL",
- "phone": "+48543234123"
}
], - "integration_key": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "shipping_type": "digital",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "name": "Black Week",
- "code": "BLACK22",
- "type": "amount",
- "target_type": "order-value",
- "value": 9.99,
- "applied_discount": 9.99
}
]
}
}| shipping_digital | boolean |
{- "data": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "order_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Produkt",
- "quantity": "12.4",
- "price": "199.99",
- "price_initial": "299.99",
- "vat_rate": "0.23",
- "schemas": [
- {
- "name": "Size",
- "value": "XL",
- "price": "49.99",
- "price_initial": "59.99"
}
], - "shipping_digital": true,
- "product": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "slug": "white-socks",
- "name": "White socks",
- "price": 10.99,
- "price_min": 11.99,
- "price_max": 19.99,
- "price_min_initial": 12.99,
- "price_max_initial": 20.99,
- "public": true,
- "visible": true,
- "available": true,
- "quantity_step": 0.05,
- "quantity": 20,
- "google_product_category": 2271,
- "vat_rate": 23,
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11",
- "shipping_digital": true,
- "purchase_limit_per_user": 5,
- "cover": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "tags": [
- {
- "name": "Sale",
- "color": 111111
}
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "has_schemas": true,
- "order": 8,
- "user_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "description_html": "<h1>Lorem ipsum dolor sit amet</h1>",
- "description_short": "string",
- "items": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Chain",
- "sku": "K121",
- "required_quantity": "5"
}, - "gallery": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "schemas": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "string",
- "name": "Size",
- "description": "string",
- "price": 9.99,
- "hidden": true,
- "required": true,
- "min": "string",
- "max": "string",
- "step": "string",
- "default": "string",
- "pattern": "string",
- "validation": "string",
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11",
- "options": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "XL",
- "price": 3.99,
- "disabled": true,
- "available": true,
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11",
- "items": [
- {
- "id": null,
- "name": null,
- "sku": null,
- "quantity": null,
- "shipping_time": null,
- "shipping_date": null,
- "unlimited_shipping_time": null,
- "unlimited_shipping_date": null,
- "availability": [ ]
}
]
}
], - "used_schemas": [
- "used-schema-ids"
]
}
], - "sets": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "AGD",
- "slug": "agd",
- "slug_suffix": "test",
- "slug_override": true,
- "public": true,
- "visible": true,
- "parent_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "children_ids": [
- "026bc5f6-8373-4aeb-972e-e78d72a67121"
], - "cover": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "attributes": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Screen size",
- "slug": "screen-size",
- "description": "Presented number is size of screen monitor",
- "min": "22",
- "max": "27",
- "type": 1,
- "global": true,
- "sortable": true,
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "attributes": [
- {
- "name": "Screen size",
- "selected_options": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Screen size",
- "index": 1,
- "value_number": "27",
- "value_date": "2022-02-22",
- "attribute_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "slug": "screen-size",
- "description": "Presented number is size of screen monitor",
- "type": 1,
- "global": true,
- "sortable": true,
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "seo": {
- "title": "Title",
- "description": "Description SEO",
- "keywords": [
- "PHP"
], - "twitter_card": "summary",
- "no_index": true,
- "og_image": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
}, - "sales": [
- {
- "name": "Black",
- "description": "Black Weekend 2021",
- "type": "amount",
- "value": "50",
- "priority": 1,
- "target_type": "order-value",
- "target_is_allow_list": true,
- "active": true
}
]
}, - "urls": [
]
}
]
}| id required | string Example: 5b320ba6-d5ee-4870-bed2-1a101704c2c4 |
| order_product_id required | string Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0 |
| is_delivered | boolean |
object Object keys are link names and values are links |
{- "is_delivered": true,
}required | Array of objects (CartItem) List of products |
| coupons | Array of strings |
| shipping_method_id | string |
| digital_shipping_method_id | string |
{- "items": [
- {
- "cartitem_id": 1,
- "product_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "quantity": 1.5,
- "schemas": {
- "119c0a63-1ea1-4769-8d5f-169f68de5598": "123459fb-39a4-4dd0-8240-14793aa1f73b",
- "02b97693-857c-4fb9-9999-47400ac5fbef": "HE + YA"
}
}
], - "coupons": [
- "BLWEEK22"
], - "shipping_method_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "digital_shipping_method_id": "026bc5f6-8373-4aeb-972e-e78d72a67121"
}{- "data": {
- "cart_total_initial": 380.7,
- "cart_total": 180.7,
- "shipping_price_initial": 38.7,
- "shipping_price": 18.7,
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11",
- "summary": 189.4,
- "items": [
- {
- "cartitem_id": 1,
- "price": 380.7,
- "price_discounted": 180.7,
- "quantity": 1
}
], - "coupons": [
- {
- "id": "1c8705ce-5fae-4468-b88a-8784cb5414a0,",
- "name": "Black Week",
- "value": 100,
- "code": "BLWEEK22"
}
], - "sales": [
- {
- "id": "1c8705ce-5fae-4468-b88a-8784cb5414a0,",
- "name": "Black Week",
- "value": 100
}
]
}
}| code required | string |
| payment_method required | string |
| continue_url | string URL that the buyer will be redirected to, after making payment |
{- "continue_url": "string"
}{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "external_id": "D2spSDJ21LSA",
- "method_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "amount": 80.92,
- "status": "pending",
- "date": "2022-05-04T12:14:45.000000Z"
}
}| code required | string |
{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "external_id": "D2spSDJ21LSA",
- "method_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "amount": 80.92,
- "status": "pending",
- "date": "2022-05-04T12:14:45.000000Z"
}
}object (MetadataQuery) search by metadata | |
object (MetadataQuery) search by metadata private | |
| ids[] | string Example: ids[]=ids[]=5a61f3a1-1cd1-4e71-bf7d-0d3a159bd6b0&ids[]=33e37b2a-44e9-4d35-88db-d9a79a61e557 Ids array search |
{- "data": [
- {
- "id": "5fb4a472-b5fd-4e9a-a4ee-bf42bde86a73",
- "name": "Small package",
- "wieght": 5.7,
- "width": 10,
- "height": 20,
- "depth": 30,
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
]
}| id | string |
| name | string |
| wieght | number Weight in kg |
| width | integer Width in cm |
| height | integer Height in cm |
| depth | integer Depth in cm |
object (Metadata) | |
object (Metadata) |
{- "id": "5fb4a472-b5fd-4e9a-a4ee-bf42bde86a73",
- "name": "Small package",
- "wieght": 5.7,
- "width": 10,
- "height": 20,
- "depth": 30,
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}{- "data": {
- "id": "5fb4a472-b5fd-4e9a-a4ee-bf42bde86a73",
- "name": "Small package",
- "wieght": 5.7,
- "width": 10,
- "height": 20,
- "depth": 30,
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
}| id required | integer |
| id | string |
| name | string |
| wieght | number Weight in kg |
| width | integer Width in cm |
| height | integer Height in cm |
| depth | integer Depth in cm |
{- "id": "5fb4a472-b5fd-4e9a-a4ee-bf42bde86a73",
- "name": "Small package",
- "wieght": 5.7,
- "width": 10,
- "height": 20,
- "depth": 30
}{- "data": {
- "id": "5fb4a472-b5fd-4e9a-a4ee-bf42bde86a73",
- "name": "Small package",
- "wieght": 5.7,
- "width": 10,
- "height": 20,
- "depth": 30,
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
}object (MetadataQuery) search by metadata | |
object (MetadataQuery) search by metadata private | |
| ids[] | string Example: ids[]=ids[]=5a61f3a1-1cd1-4e71-bf7d-0d3a159bd6b0&ids[]=33e37b2a-44e9-4d35-88db-d9a79a61e557 Ids array search |
{- "data": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "slug": "terms-and-conditions",
- "name": "Terms & Conditions",
- "public": true,
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
]
}| name required | string Name displayed as a page header |
| slug required | string Name used in the URL path |
| public | boolean Whether page is visible to unauthorized users |
| content_html required | string HTML formated text to be displayed as a main content under the page header |
object (Seo_SeoStore) | |
object (Metadata) | |
object (Metadata) |
{- "name": "Terms & Conditions",
- "slug": "terms-and-conditions",
- "public": true,
- "content_html": "<h1>Lorem ipsum dolor sit amet</h1>",
- "seo": {
- "title": "Title",
- "description": "Description SEO",
- "keywords": [
- "PHP"
], - "twitter_card": "summary",
- "no_index": true,
- "og_image_id": "0006c3a0-21af-4485-b7fe-9c42233cf03"
}, - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "slug": "terms-and-conditions",
- "name": "Terms & Conditions",
- "public": true,
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "content_html": "<h1>Lorem ipsum dolor sit amet</h1>",
- "seo": {
- "title": "Title",
- "description": "Description SEO",
- "keywords": [
- "PHP"
], - "twitter_card": "summary",
- "no_index": true,
- "og_image": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
}
}
}{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "slug": "terms-and-conditions",
- "name": "Terms & Conditions",
- "public": true,
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "content_html": "<h1>Lorem ipsum dolor sit amet</h1>",
- "seo": {
- "title": "Title",
- "description": "Description SEO",
- "keywords": [
- "PHP"
], - "twitter_card": "summary",
- "no_index": true,
- "og_image": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
}
}
}{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "slug": "terms-and-conditions",
- "name": "Terms & Conditions",
- "public": true,
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "content_html": "<h1>Lorem ipsum dolor sit amet</h1>",
- "seo": {
- "title": "Title",
- "description": "Description SEO",
- "keywords": [
- "PHP"
], - "twitter_card": "summary",
- "no_index": true,
- "og_image": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
}
}
}| id required | integer |
| name | string Name displayed as a page header |
| slug | string Name used in the URL path |
| public | boolean Whether page is visible to unauthorized users |
| content_html | string HTML formatted text to be displayed as a main content under the page header |
object (Seo_SeoStore) |
{- "name": "Terms & Conditions",
- "slug": "terms-and-conditions",
- "public": true,
- "content_html": "<h1>Lorem ipsum dolor sit amet</h1>",
- "seo": {
- "title": "Title",
- "description": "Description SEO",
- "keywords": [
- "PHP"
], - "twitter_card": "summary",
- "no_index": true,
- "og_image_id": "0006c3a0-21af-4485-b7fe-9c42233cf03"
}
}{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "slug": "terms-and-conditions",
- "name": "Terms & Conditions",
- "public": true,
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "content_html": "<h1>Lorem ipsum dolor sit amet</h1>",
- "seo": {
- "title": "Title",
- "description": "Description SEO",
- "keywords": [
- "PHP"
], - "twitter_card": "summary",
- "no_index": true,
- "og_image": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
}
}
}| shipping_method_id | string |
| order_code | string |
| ids[] | string Example: ids[]=ids[]=5a61f3a1-1cd1-4e71-bf7d-0d3a159bd6b0&ids[]=33e37b2a-44e9-4d35-88db-d9a79a61e557 Ids array search |
{- "data": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Heseya Pay",
- "alias": "heseya",
- "public": true,
- "icon": "string",
- "url": "string"
}
]
}| name | string |
| public | boolean |
| icon | string |
| url | string |
{- "name": "Heseya Pay",
- "public": true,
- "icon": "string",
- "url": "string"
}{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Heseya Pay",
- "alias": "heseya",
- "public": true,
- "icon": "string",
- "url": "string"
}
}| id required | string |
| name | string |
| public | boolean |
| icon | string |
| url | string |
{- "name": "Heseya Pay",
- "public": true,
- "icon": "string",
- "url": "string"
}{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Heseya Pay",
- "alias": "heseya",
- "public": true,
- "icon": "string",
- "url": "string"
}
}{- "data": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "external_id": "D2spSDJ21LSA",
- "method_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "amount": 80.92,
- "status": "pending",
- "date": "2022-05-04T12:14:45.000000Z"
}
]
}| external_id | string |
| method_id | string |
| order_id | string |
| amount | number |
| status | string |
{- "external_id": "D2spSDJ21LSA",
- "method_id": "0006c3a0-21af-4485-b7fe-9c42233cf03a",
- "order_id": "0006c3a0-21af-4485-b7fe-9c42233cf03a",
- "amount": 80.92,
- "status": "pending"
}{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "external_id": "D2spSDJ21LSA",
- "method_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "amount": 80.92,
- "status": "pending",
- "date": "2022-05-04T12:14:45.000000Z"
}
}{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "external_id": "D2spSDJ21LSA",
- "method_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "amount": 80.92,
- "status": "pending",
- "date": "2022-05-04T12:14:45.000000Z"
}
}| id required | string |
| external_id | string |
| method_id | string |
| order_id | string |
| amount | number |
| status | string |
{- "external_id": "D2spSDJ21LSA",
- "method_id": "0006c3a0-21af-4485-b7fe-9c42233cf03a",
- "order_id": "0006c3a0-21af-4485-b7fe-9c42233cf03a",
- "amount": 80.92,
- "status": "pending"
}{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "external_id": "D2spSDJ21LSA",
- "method_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "amount": 80.92,
- "status": "pending",
- "date": "2022-05-04T12:14:45.000000Z"
}
}| assignable | boolean Is the permission assignable by current user |
{- "data": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "products.add",
- "description": "Permission to add products",
- "assignable": true
}
]
}| search | string Full text search |
| name | string Name search |
| description | string Description search |
| assignable | boolean Is the role assignable by current user |
object (MetadataQuery) search by metadata | |
object (MetadataQuery) search by metadata private | |
| ids[] | string Example: ids[]=ids[]=5a61f3a1-1cd1-4e71-bf7d-0d3a159bd6b0&ids[]=33e37b2a-44e9-4d35-88db-d9a79a61e557 Ids array search |
{- "data": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Admin",
- "description": "Role with permission to everything",
- "assignable": true,
- "deletable": true,
- "users_count": 10,
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
]
}| name required | string Name of the role |
| description | string Description of the role |
| permissions | Array of strings Permission names |
object (Metadata) | |
object (Metadata) |
{- "name": "Admin",
- "description": "Role with permission to everything",
- "permissions": [
- "roles.add"
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Admin",
- "description": "Role with permission to everything",
- "assignable": true,
- "deletable": true,
- "users_count": 10,
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "permissions": [
- "roles.show_details"
], - "locked_permissions": true
}
}{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Admin",
- "description": "Role with permission to everything",
- "assignable": true,
- "deletable": true,
- "users_count": 10,
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "permissions": [
- "roles.show_details"
], - "locked_permissions": true
}
}| id required | string |
| name | string Name of the role |
| description | string Description of the role |
| permissions | Array of strings Permission names |
{- "name": "Admin",
- "description": "Role with permission to everything",
- "permissions": [
- "roles.add"
]
}{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Admin",
- "description": "Role with permission to everything",
- "assignable": true,
- "deletable": true,
- "users_count": 10,
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "permissions": [
- "roles.show_details"
], - "locked_permissions": true
}
}| search | string Full text search |
| name | string Name search |
| slug | string Slug search |
| public | boolean Is public search |
| full | boolean Returns details resource |
| sets[] | string Example: sets[]=sets[]=category-teapots&sets[]=category-mugs Product set array slug search |
| sets_not[] | string Example: sets_not[]=sets_not[]=category-teapots&sets_not[]=category-mugs Product set array slug search negation |
| sort | string Example: sort=price:asc,created_at:desc,name Sorting string |
| tags[] | string Example: tags[]=tags[]=5a61f3a1-1cd1-4e71-bf7d-0d3a159bd6b0&tags[]=33e37b2a-44e9-4d35-88db-d9a79a61e557 Tag array id search |
| tags_not[] | string Example: tags_not[]=tags_not[]=5a61f3a1-1cd1-4e71-bf7d-0d3a159bd6b0&tags_not[]=33e37b2a-44e9-4d35-88db-d9a79a61e557 Tag array id search negation |
| available | boolean Is available search |
| price.min | number |
| price.max | number |
| has_cover | boolean Product has cover |
| has_items | boolean Product has items |
| has_schemas | boolean Product has schemas |
| shipping_digital | boolean Product has digital shipping |
object search by attributes | |
object search by attributes negation | |
object (MetadataQuery) search by metadata | |
object (MetadataQuery) search by metadata private | |
| ids[] | string Example: ids[]=ids[]=5a61f3a1-1cd1-4e71-bf7d-0d3a159bd6b0&ids[]=33e37b2a-44e9-4d35-88db-d9a79a61e557 Ids array search |
await heseya.Products.get(params)
{- "data": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "slug": "white-socks",
- "name": "White socks",
- "price": 10.99,
- "price_min": 11.99,
- "price_max": 19.99,
- "price_min_initial": 12.99,
- "price_max_initial": 20.99,
- "public": true,
- "visible": true,
- "available": true,
- "quantity_step": 0.05,
- "quantity": 20,
- "google_product_category": 2271,
- "vat_rate": 23,
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11",
- "shipping_digital": true,
- "purchase_limit_per_user": 5,
- "cover": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "tags": [
- {
- "name": "Sale",
- "color": 111111
}
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "has_schemas": true,
- "attributes": [
- {
- "name": "Screen size",
- "selected_options": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Screen size",
- "index": 1,
- "value_number": "27",
- "value_date": "2022-02-22",
- "attribute_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
}
]
}
]
}object (Metadata) | |
object (Metadata) | |
| name required | string |
| slug required | string |
| price required | number |
| public required | boolean |
| description_html | string |
| description_short | string |
| quantity_step | number |
| vat_rate | number |
| shipping_digital required | boolean Whether product is digital and not delivered by physical means |
| purchase_limit_per_user | number |
| media | Array of strings |
| tags | Array of strings |
object | |
Array of objects | |
| schemas | Array of strings |
| sets | Array of strings |
| google_product_category | integer |
object (Seo_SeoStore) |
{- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "name": "string",
- "slug": "string",
- "price": 0,
- "public": true,
- "description_html": "string",
- "description_short": "string",
- "quantity_step": 0,
- "vat_rate": 0,
- "shipping_digital": true,
- "purchase_limit_per_user": 0,
- "media": [
- "0006c3a0-21af-4485-b7fe-9c42233cf03a"
], - "tags": [
- "0006c3a0-21af-4485-b7fe-9c42233cf03a"
], - "attributes": {
- "0006c3a0-21af-4485-b7fe-9c42233cf03a": "0006c654-21bn-44rt-b7fe-9c4uyji8f03a"
}, - "items": [
- {
- "id": "0006c3a0-21af-4485-b7fe-9c42233cf03a",
- "required_quantity": 2
}
], - "schemas": [
- "0006c3a0-21af-4485-b7fe-9c42233cf03a"
], - "sets": [
- "0006c3a0-21af-4485-b7fe-9c42233cf03a"
], - "google_product_category": 0,
- "seo": {
- "title": "Title",
- "description": "Description SEO",
- "keywords": [
- "PHP"
], - "twitter_card": "summary",
- "no_index": true,
- "og_image_id": "0006c3a0-21af-4485-b7fe-9c42233cf03"
}
}{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "slug": "white-socks",
- "name": "White socks",
- "price": 10.99,
- "price_min": 11.99,
- "price_max": 19.99,
- "price_min_initial": 12.99,
- "price_max_initial": 20.99,
- "public": true,
- "visible": true,
- "available": true,
- "quantity_step": 0.05,
- "quantity": 20,
- "google_product_category": 2271,
- "vat_rate": 23,
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11",
- "shipping_digital": true,
- "purchase_limit_per_user": 5,
- "cover": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "tags": [
- {
- "name": "Sale",
- "color": 111111
}
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "has_schemas": true,
- "order": 8,
- "user_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "description_html": "<h1>Lorem ipsum dolor sit amet</h1>",
- "description_short": "string",
- "items": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Chain",
- "sku": "K121",
- "required_quantity": "5"
}, - "gallery": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "schemas": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "string",
- "name": "Size",
- "description": "string",
- "price": 9.99,
- "hidden": true,
- "required": true,
- "min": "string",
- "max": "string",
- "step": "string",
- "default": "string",
- "pattern": "string",
- "validation": "string",
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11",
- "options": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "XL",
- "price": 3.99,
- "disabled": true,
- "available": true,
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11",
- "items": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Chain",
- "sku": "K121",
- "quantity": "20",
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11",
- "unlimited_shipping_time": 5,
- "unlimited_shipping_date": "2021-09-13T11:11",
- "availability": [
- {
- "quantity": null,
- "shipping_time": null,
- "shipping_date": null
}
]
}
]
}
], - "used_schemas": [
- "used-schema-ids"
]
}
], - "sets": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "AGD",
- "slug": "agd",
- "slug_suffix": "test",
- "slug_override": true,
- "public": true,
- "visible": true,
- "parent_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "children_ids": [
- "026bc5f6-8373-4aeb-972e-e78d72a67121"
], - "cover": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "attributes": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Screen size",
- "slug": "screen-size",
- "description": "Presented number is size of screen monitor",
- "min": "22",
- "max": "27",
- "type": 1,
- "global": true,
- "sortable": true,
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "attributes": [
- {
- "name": "Screen size",
- "selected_options": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Screen size",
- "index": 1,
- "value_number": "27",
- "value_date": "2022-02-22",
- "attribute_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "slug": "screen-size",
- "description": "Presented number is size of screen monitor",
- "type": 1,
- "global": true,
- "sortable": true,
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "seo": {
- "title": "Title",
- "description": "Description SEO",
- "keywords": [
- "PHP"
], - "twitter_card": "summary",
- "no_index": true,
- "og_image": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
}, - "sales": [
- {
- "name": "Black",
- "description": "Black Weekend 2021",
- "type": "amount",
- "value": "50",
- "priority": 1,
- "target_type": "order-value",
- "target_is_allow_list": true,
- "active": true
}
]
}
}{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "slug": "white-socks",
- "name": "White socks",
- "price": 10.99,
- "price_min": 11.99,
- "price_max": 19.99,
- "price_min_initial": 12.99,
- "price_max_initial": 20.99,
- "public": true,
- "visible": true,
- "available": true,
- "quantity_step": 0.05,
- "quantity": 20,
- "google_product_category": 2271,
- "vat_rate": 23,
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11",
- "shipping_digital": true,
- "purchase_limit_per_user": 5,
- "cover": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "tags": [
- {
- "name": "Sale",
- "color": 111111
}
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "has_schemas": true,
- "order": 8,
- "user_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "description_html": "<h1>Lorem ipsum dolor sit amet</h1>",
- "description_short": "string",
- "items": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Chain",
- "sku": "K121",
- "required_quantity": "5"
}, - "gallery": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "schemas": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "string",
- "name": "Size",
- "description": "string",
- "price": 9.99,
- "hidden": true,
- "required": true,
- "min": "string",
- "max": "string",
- "step": "string",
- "default": "string",
- "pattern": "string",
- "validation": "string",
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11",
- "options": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "XL",
- "price": 3.99,
- "disabled": true,
- "available": true,
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11",
- "items": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Chain",
- "sku": "K121",
- "quantity": "20",
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11",
- "unlimited_shipping_time": 5,
- "unlimited_shipping_date": "2021-09-13T11:11",
- "availability": [
- {
- "quantity": null,
- "shipping_time": null,
- "shipping_date": null
}
]
}
]
}
], - "used_schemas": [
- "used-schema-ids"
]
}
], - "sets": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "AGD",
- "slug": "agd",
- "slug_suffix": "test",
- "slug_override": true,
- "public": true,
- "visible": true,
- "parent_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "children_ids": [
- "026bc5f6-8373-4aeb-972e-e78d72a67121"
], - "cover": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "attributes": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Screen size",
- "slug": "screen-size",
- "description": "Presented number is size of screen monitor",
- "min": "22",
- "max": "27",
- "type": 1,
- "global": true,
- "sortable": true,
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "attributes": [
- {
- "name": "Screen size",
- "selected_options": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Screen size",
- "index": 1,
- "value_number": "27",
- "value_date": "2022-02-22",
- "attribute_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "slug": "screen-size",
- "description": "Presented number is size of screen monitor",
- "type": 1,
- "global": true,
- "sortable": true,
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "seo": {
- "title": "Title",
- "description": "Description SEO",
- "keywords": [
- "PHP"
], - "twitter_card": "summary",
- "no_index": true,
- "og_image": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
}, - "sales": [
- {
- "name": "Black",
- "description": "Black Weekend 2021",
- "type": "amount",
- "value": "50",
- "priority": 1,
- "target_type": "order-value",
- "target_is_allow_list": true,
- "active": true
}
]
}
}{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "slug": "white-socks",
- "name": "White socks",
- "price": 10.99,
- "price_min": 11.99,
- "price_max": 19.99,
- "price_min_initial": 12.99,
- "price_max_initial": 20.99,
- "public": true,
- "visible": true,
- "available": true,
- "quantity_step": 0.05,
- "quantity": 20,
- "google_product_category": 2271,
- "vat_rate": 23,
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11",
- "shipping_digital": true,
- "purchase_limit_per_user": 5,
- "cover": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "tags": [
- {
- "name": "Sale",
- "color": 111111
}
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "has_schemas": true,
- "order": 8,
- "user_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "description_html": "<h1>Lorem ipsum dolor sit amet</h1>",
- "description_short": "string",
- "items": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Chain",
- "sku": "K121",
- "required_quantity": "5"
}, - "gallery": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "schemas": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "string",
- "name": "Size",
- "description": "string",
- "price": 9.99,
- "hidden": true,
- "required": true,
- "min": "string",
- "max": "string",
- "step": "string",
- "default": "string",
- "pattern": "string",
- "validation": "string",
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11",
- "options": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "XL",
- "price": 3.99,
- "disabled": true,
- "available": true,
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11",
- "items": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Chain",
- "sku": "K121",
- "quantity": "20",
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11",
- "unlimited_shipping_time": 5,
- "unlimited_shipping_date": "2021-09-13T11:11",
- "availability": [
- {
- "quantity": null,
- "shipping_time": null,
- "shipping_date": null
}
]
}
]
}
], - "used_schemas": [
- "used-schema-ids"
]
}
], - "sets": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "AGD",
- "slug": "agd",
- "slug_suffix": "test",
- "slug_override": true,
- "public": true,
- "visible": true,
- "parent_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "children_ids": [
- "026bc5f6-8373-4aeb-972e-e78d72a67121"
], - "cover": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "attributes": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Screen size",
- "slug": "screen-size",
- "description": "Presented number is size of screen monitor",
- "min": "22",
- "max": "27",
- "type": 1,
- "global": true,
- "sortable": true,
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "attributes": [
- {
- "name": "Screen size",
- "selected_options": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Screen size",
- "index": 1,
- "value_number": "27",
- "value_date": "2022-02-22",
- "attribute_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "slug": "screen-size",
- "description": "Presented number is size of screen monitor",
- "type": 1,
- "global": true,
- "sortable": true,
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "seo": {
- "title": "Title",
- "description": "Description SEO",
- "keywords": [
- "PHP"
], - "twitter_card": "summary",
- "no_index": true,
- "og_image": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
}, - "sales": [
- {
- "name": "Black",
- "description": "Black Weekend 2021",
- "type": "amount",
- "value": "50",
- "priority": 1,
- "target_type": "order-value",
- "target_is_allow_list": true,
- "active": true
}
]
}
}| id required | string |
| name | string |
| slug | string |
| price | number |
| public | boolean |
| description_html | string |
| description_short | string |
| quantity_step | number |
| vat_rate | number |
| shipping_digital | boolean Whether product is digital and not delivered by physical means |
| purchase_limit_per_user | number |
| media | Array of strings |
| tags | Array of strings |
object | |
Array of objects | |
| schemas | Array of strings |
| sets | Array of strings |
| google_product_category | integer |
object (Seo_SeoStore) |
{- "name": "string",
- "slug": "string",
- "price": 0,
- "public": true,
- "description_html": "string",
- "description_short": "string",
- "quantity_step": 0,
- "vat_rate": 0,
- "shipping_digital": true,
- "purchase_limit_per_user": 0,
- "media": [
- "0006c3a0-21af-4485-b7fe-9c42233cf03a"
], - "tags": [
- "0006c3a0-21af-4485-b7fe-9c42233cf03a"
], - "attributes": {
- "0006c3a0-21af-4485-b7fe-9c42233cf03a": "0006c654-21bn-44rt-b7fe-9c4uyji8f03a"
}, - "items": [
- {
- "id": "0006c3a0-21af-4485-b7fe-9c42233cf03a",
- "required_quantity": 2
}
], - "schemas": [
- "0006c3a0-21af-4485-b7fe-9c42233cf03a"
], - "sets": [
- "0006c3a0-21af-4485-b7fe-9c42233cf03a"
], - "google_product_category": 0,
- "seo": {
- "title": "Title",
- "description": "Description SEO",
- "keywords": [
- "PHP"
], - "twitter_card": "summary",
- "no_index": true,
- "og_image_id": "0006c3a0-21af-4485-b7fe-9c42233cf03"
}
}{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "slug": "white-socks",
- "name": "White socks",
- "price": 10.99,
- "price_min": 11.99,
- "price_max": 19.99,
- "price_min_initial": 12.99,
- "price_max_initial": 20.99,
- "public": true,
- "visible": true,
- "available": true,
- "quantity_step": 0.05,
- "quantity": 20,
- "google_product_category": 2271,
- "vat_rate": 23,
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11",
- "shipping_digital": true,
- "purchase_limit_per_user": 5,
- "cover": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "tags": [
- {
- "name": "Sale",
- "color": 111111
}
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "has_schemas": true,
- "order": 8,
- "user_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "description_html": "<h1>Lorem ipsum dolor sit amet</h1>",
- "description_short": "string",
- "items": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Chain",
- "sku": "K121",
- "required_quantity": "5"
}, - "gallery": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "schemas": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "string",
- "name": "Size",
- "description": "string",
- "price": 9.99,
- "hidden": true,
- "required": true,
- "min": "string",
- "max": "string",
- "step": "string",
- "default": "string",
- "pattern": "string",
- "validation": "string",
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11",
- "options": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "XL",
- "price": 3.99,
- "disabled": true,
- "available": true,
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11",
- "items": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Chain",
- "sku": "K121",
- "quantity": "20",
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11",
- "unlimited_shipping_time": 5,
- "unlimited_shipping_date": "2021-09-13T11:11",
- "availability": [
- {
- "quantity": null,
- "shipping_time": null,
- "shipping_date": null
}
]
}
]
}
], - "used_schemas": [
- "used-schema-ids"
]
}
], - "sets": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "AGD",
- "slug": "agd",
- "slug_suffix": "test",
- "slug_override": true,
- "public": true,
- "visible": true,
- "parent_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "children_ids": [
- "026bc5f6-8373-4aeb-972e-e78d72a67121"
], - "cover": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "attributes": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Screen size",
- "slug": "screen-size",
- "description": "Presented number is size of screen monitor",
- "min": "22",
- "max": "27",
- "type": 1,
- "global": true,
- "sortable": true,
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "attributes": [
- {
- "name": "Screen size",
- "selected_options": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Screen size",
- "index": 1,
- "value_number": "27",
- "value_date": "2022-02-22",
- "attribute_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "slug": "screen-size",
- "description": "Presented number is size of screen monitor",
- "type": 1,
- "global": true,
- "sortable": true,
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "seo": {
- "title": "Title",
- "description": "Description SEO",
- "keywords": [
- "PHP"
], - "twitter_card": "summary",
- "no_index": true,
- "og_image": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
}, - "sales": [
- {
- "name": "Black",
- "description": "Black Weekend 2021",
- "type": "amount",
- "value": "50",
- "priority": 1,
- "target_type": "order-value",
- "target_is_allow_list": true,
- "active": true
}
]
}
}| root | boolean Return only root lists |
| tree | boolean Return sets starting from root with recursively nested children instead of id's |
| search | string Full text search |
| name | string Name search |
| slug | string Slug search |
| public | boolean Is public search |
| parent_id | string Example: parent_id= 019fc7e8-af32-476f-ba04-068b86833830 UUID of parent set |
object (MetadataQuery) search by metadata | |
object (MetadataQuery) search by metadata private | |
| ids[] | string Example: ids[]=ids[]=5a61f3a1-1cd1-4e71-bf7d-0d3a159bd6b0&ids[]=33e37b2a-44e9-4d35-88db-d9a79a61e557 Ids array search |
{- "data": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "AGD",
- "slug": "agd",
- "slug_suffix": "test",
- "slug_override": true,
- "public": true,
- "visible": true,
- "parent_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "children_ids": [
- "026bc5f6-8373-4aeb-972e-e78d72a67121"
], - "cover": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "attributes": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Screen size",
- "slug": "screen-size",
- "description": "Presented number is size of screen monitor",
- "min": "22",
- "max": "27",
- "type": 1,
- "global": true,
- "sortable": true,
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
]
}| tree | boolean Return set with recursively nested children instead of id's |
| name required | string Name displayed to the user |
| slug_suffix required | string Name used in the URL path usually proceeded by parent slug |
| slug_override required | boolean Whether to use slug as suffix to parent or to override the entire slug |
| public | boolean Whether set is visible to unauthorized users |
| description_html | string HTML formated text to be displayed as a product set description |
| cover_id | string Id of media cover |
| parent_id | string Id of set, this set belongs to |
| children_ids | Array of strings Ids of assigned subsets |
object (Seo_SeoStore) | |
| attributes | Array of strings Array of assigned attributes ids |
object (Metadata) | |
object (Metadata) |
{- "name": "AGD",
- "slug_suffix": "agd",
- "slug_override": true,
- "public": true,
- "description_html": "<h1>Lorem ipsum dolor sit amet</h1>",
- "cover_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "parent_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "children_ids": [
- "026bc5f6-8373-4aeb-972e-e78d72a67121"
], - "seo": {
- "title": "Title",
- "description": "Description SEO",
- "keywords": [
- "PHP"
], - "twitter_card": "summary",
- "no_index": true,
- "og_image_id": "0006c3a0-21af-4485-b7fe-9c42233cf03"
}, - "attributes": [
- "026bc5f6-8373-4aeb-972e-e78d72a67121"
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "AGD",
- "slug": "agd",
- "public": true,
- "public_parent": true,
- "description_html": "<h1>Lorem ipsum dolor sit amet</h1>",
- "cover": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "parent": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "AGD",
- "slug": "agd",
- "slug_suffix": "test",
- "slug_override": true,
- "public": true,
- "visible": true,
- "parent_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "children_ids": [
- "026bc5f6-8373-4aeb-972e-e78d72a67121"
], - "cover": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "attributes": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Screen size",
- "slug": "screen-size",
- "description": "Presented number is size of screen monitor",
- "min": "22",
- "max": "27",
- "type": 1,
- "global": true,
- "sortable": true,
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "children_ids": [
- "026bc5f6-8373-4aeb-972e-e78d72a67121"
], - "seo": {
- "title": "Title",
- "description": "Description SEO",
- "keywords": [
- "PHP"
], - "twitter_card": "summary",
- "no_index": true,
- "og_image": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
}, - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
}| slug required | string |
| tree | boolean Return set with recursively nested children instead of id's |
{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "AGD",
- "slug": "agd",
- "public": true,
- "public_parent": true,
- "description_html": "<h1>Lorem ipsum dolor sit amet</h1>",
- "cover": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "parent": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "AGD",
- "slug": "agd",
- "slug_suffix": "test",
- "slug_override": true,
- "public": true,
- "visible": true,
- "parent_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "children_ids": [
- "026bc5f6-8373-4aeb-972e-e78d72a67121"
], - "cover": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "attributes": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Screen size",
- "slug": "screen-size",
- "description": "Presented number is size of screen monitor",
- "min": "22",
- "max": "27",
- "type": 1,
- "global": true,
- "sortable": true,
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "children_ids": [
- "026bc5f6-8373-4aeb-972e-e78d72a67121"
], - "seo": {
- "title": "Title",
- "description": "Description SEO",
- "keywords": [
- "PHP"
], - "twitter_card": "summary",
- "no_index": true,
- "og_image": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
}, - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
}| id required | string |
| tree | boolean Return set with recursively nested children instead of id's |
{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "AGD",
- "slug": "agd",
- "public": true,
- "public_parent": true,
- "description_html": "<h1>Lorem ipsum dolor sit amet</h1>",
- "cover": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "parent": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "AGD",
- "slug": "agd",
- "slug_suffix": "test",
- "slug_override": true,
- "public": true,
- "visible": true,
- "parent_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "children_ids": [
- "026bc5f6-8373-4aeb-972e-e78d72a67121"
], - "cover": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "attributes": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Screen size",
- "slug": "screen-size",
- "description": "Presented number is size of screen monitor",
- "min": "22",
- "max": "27",
- "type": 1,
- "global": true,
- "sortable": true,
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "children_ids": [
- "026bc5f6-8373-4aeb-972e-e78d72a67121"
], - "seo": {
- "title": "Title",
- "description": "Description SEO",
- "keywords": [
- "PHP"
], - "twitter_card": "summary",
- "no_index": true,
- "og_image": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
}, - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
}| id required | string Example: 0006c3a0-21af-4485-b7fe-9c42233cf03a |
| tree | boolean Return set with recursively nested children instead of id's |
| name | string Name displayed to the user |
| slug_suffix | string Name used in the URL path usually proceeded by parent slug |
| slug_override | boolean Whether to use slug as suffix to parent or to override the entire slug |
| public | boolean Whether set is visible to unauthorized users |
| description_html | string HTML formated text to be displayed as a product set description |
| cover_id | string Id of media cover |
| parent_id | string Id of set, this set belongs to |
| children_ids | Array of strings Ids of assigned subsets |
object (Seo_SeoStore) | |
| attributes | Array of strings Array of assigned attributes ids |
{- "name": "AGD",
- "slug_suffix": "agd",
- "slug_override": true,
- "public": true,
- "description_html": "<h1>Lorem ipsum dolor sit amet</h1>",
- "cover_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "parent_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "children_ids": [
- "026bc5f6-8373-4aeb-972e-e78d72a67121"
], - "seo": {
- "title": "Title",
- "description": "Description SEO",
- "keywords": [
- "PHP"
], - "twitter_card": "summary",
- "no_index": true,
- "og_image_id": "0006c3a0-21af-4485-b7fe-9c42233cf03"
}, - "attributes": [
- "026bc5f6-8373-4aeb-972e-e78d72a67121"
]
}{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "AGD",
- "slug": "agd",
- "public": true,
- "public_parent": true,
- "description_html": "<h1>Lorem ipsum dolor sit amet</h1>",
- "cover": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "parent": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "AGD",
- "slug": "agd",
- "slug_suffix": "test",
- "slug_override": true,
- "public": true,
- "visible": true,
- "parent_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "children_ids": [
- "026bc5f6-8373-4aeb-972e-e78d72a67121"
], - "cover": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "attributes": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Screen size",
- "slug": "screen-size",
- "description": "Presented number is size of screen monitor",
- "min": "22",
- "max": "27",
- "type": 1,
- "global": true,
- "sortable": true,
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "children_ids": [
- "026bc5f6-8373-4aeb-972e-e78d72a67121"
], - "seo": {
- "title": "Title",
- "description": "Description SEO",
- "keywords": [
- "PHP"
], - "twitter_card": "summary",
- "no_index": true,
- "og_image": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
}, - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
}| id required | string Example: 0006c3a0-21af-4485-b7fe-9c42233cf03a |
| product_sets required | Array of strings Ids of reordered sets |
{- "product_sets": [
- "026bc5f6-8373-4aeb-972e-e78d72a67121"
]
}| id required | string Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0 |
| limit | number Pagination limit |
{- "data": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "slug": "white-socks",
- "name": "White socks",
- "price": 10.99,
- "price_min": 11.99,
- "price_max": 19.99,
- "price_min_initial": 12.99,
- "price_max_initial": 20.99,
- "public": true,
- "visible": true,
- "available": true,
- "quantity_step": 0.05,
- "quantity": 20,
- "google_product_category": 2271,
- "vat_rate": 23,
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11",
- "shipping_digital": true,
- "purchase_limit_per_user": 5,
- "cover": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "tags": [
- {
- "name": "Sale",
- "color": 111111
}
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "has_schemas": true
}
]
}| id required | string Example: 0006c3a0-21af-4485-b7fe-9c42233cf03a List of product id's |
| products | Array of strings Ids of assigned products |
{- "products": [
- "026bc5f6-8373-4aeb-972e-e78d72a67121"
]
}{- "data": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "slug": "white-socks",
- "name": "White socks",
- "price": 10.99,
- "price_min": 11.99,
- "price_max": 19.99,
- "price_min_initial": 12.99,
- "price_max_initial": 20.99,
- "public": true,
- "visible": true,
- "available": true,
- "quantity_step": 0.05,
- "quantity": 20,
- "google_product_category": 2271,
- "vat_rate": 23,
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11",
- "shipping_digital": true,
- "purchase_limit_per_user": 5,
- "cover": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "tags": [
- {
- "name": "Sale",
- "color": 111111
}
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "has_schemas": true
}
]
}| id | string Product set id |
required | Array of objects Ids of reordered sets |
{- "products": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "order": 5
}
]
}{- "data": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "product_set": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "AGD",
- "slug": "agd",
- "slug_suffix": "test",
- "slug_override": true,
- "public": true,
- "visible": true,
- "parent_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "children_ids": [
- "026bc5f6-8373-4aeb-972e-e78d72a67121"
], - "cover": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "attributes": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Screen size",
- "slug": "screen-size",
- "description": "Presented number is size of screen monitor",
- "min": "22",
- "max": "27",
- "type": 1,
- "global": true,
- "sortable": true,
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "created_at": "2021-09-13T11:11"
}
]
}| product_set_id required | string |
{- "product_set_id": "026bc5f6-8373-4aeb-972e-e78d72a67121"
}{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "product_set": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "AGD",
- "slug": "agd",
- "slug_suffix": "test",
- "slug_override": true,
- "public": true,
- "visible": true,
- "parent_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "children_ids": [
- "026bc5f6-8373-4aeb-972e-e78d72a67121"
], - "cover": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "attributes": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Screen size",
- "slug": "screen-size",
- "description": "Presented number is size of screen monitor",
- "min": "22",
- "max": "27",
- "type": 1,
- "global": true,
- "sortable": true,
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "created_at": "2021-09-13T11:11"
}
}| id required | string Example: 0006c3a0-21af-4485-b7fe-9c42233cf03a Product set id |
{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "product_set": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "AGD",
- "slug": "agd",
- "slug_suffix": "test",
- "slug_override": true,
- "public": true,
- "visible": true,
- "parent_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "children_ids": [
- "026bc5f6-8373-4aeb-972e-e78d72a67121"
], - "cover": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "attributes": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Screen size",
- "slug": "screen-size",
- "description": "Presented number is size of screen monitor",
- "min": "22",
- "max": "27",
- "type": 1,
- "global": true,
- "sortable": true,
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "created_at": "2021-09-13T11:11"
}
}| name | string Example: name=test |
| hidden | boolean |
| required | boolean |
| search | string Example: search=test |
| sort | string Example: sort=test |
object (MetadataQuery) search by metadata | |
object (MetadataQuery) search by metadata private | |
| ids[] | string Example: ids[]=ids[]=5a61f3a1-1cd1-4e71-bf7d-0d3a159bd6b0&ids[]=33e37b2a-44e9-4d35-88db-d9a79a61e557 Ids array search |
{- "data": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "string",
- "name": "Size",
- "description": "string",
- "price": 9.99,
- "hidden": true,
- "required": true,
- "min": "string",
- "max": "string",
- "step": "string",
- "default": "string",
- "pattern": "string",
- "validation": "string",
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11",
- "options": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "XL",
- "price": 3.99,
- "disabled": true,
- "available": true,
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11",
- "items": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Chain",
- "sku": "K121",
- "quantity": "20",
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11",
- "unlimited_shipping_time": 5,
- "unlimited_shipping_date": "2021-09-13T11:11",
- "availability": [
- {
- "quantity": "20",
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11"
}
]
}
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "used_schemas": [
- "used-schema-ids"
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
]
}| type | string Enum: "string" "numeric" "boolean" "date" "select" "file" "multiply" "multiply_schema" |
| name | string |
| description | string |
| price | number |
| hidden | boolean |
| required | boolean |
| min | string |
| max | string |
| step | string |
| default | string |
| pattern | string |
| validation | string |
| shipping_time | integer |
| shipping_date | string <date-time> |
Array of objects | |
| used_schemas | Array of strings |
{- "type": "string",
- "name": "Size",
- "description": "string",
- "price": 9.99,
- "hidden": true,
- "required": true,
- "min": "string",
- "max": "string",
- "step": "string",
- "default": "string",
- "pattern": "string",
- "validation": "string",
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11",
- "options": [
- {
- "name": "XL",
- "price": 3.99,
- "disabled": true,
- "items": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121"
}
]
}
], - "used_schemas": [
- "026bc5f6-8373-4aeb-972e-e78d72a67121"
]
}{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "string",
- "name": "Size",
- "description": "string",
- "price": 9.99,
- "hidden": true,
- "required": true,
- "min": "string",
- "max": "string",
- "step": "string",
- "default": "string",
- "pattern": "string",
- "validation": "string",
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11",
- "options": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "XL",
- "price": 3.99,
- "disabled": true,
- "available": true,
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11",
- "items": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Chain",
- "sku": "K121",
- "quantity": "20",
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11",
- "unlimited_shipping_time": 5,
- "unlimited_shipping_date": "2021-09-13T11:11",
- "availability": [
- {
- "quantity": "20",
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11"
}
]
}
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "used_schemas": [
- "used-schema-ids"
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
}| id required | string Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0 |
{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "string",
- "name": "Size",
- "description": "string",
- "price": 9.99,
- "hidden": true,
- "required": true,
- "min": "string",
- "max": "string",
- "step": "string",
- "default": "string",
- "pattern": "string",
- "validation": "string",
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11",
- "options": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "XL",
- "price": 3.99,
- "disabled": true,
- "available": true,
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11",
- "items": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Chain",
- "sku": "K121",
- "quantity": "20",
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11",
- "unlimited_shipping_time": 5,
- "unlimited_shipping_date": "2021-09-13T11:11",
- "availability": [
- {
- "quantity": "20",
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11"
}
]
}
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "used_schemas": [
- "used-schema-ids"
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
}| id required | string Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0 |
| type | string Enum: "string" "numeric" "boolean" "date" "select" "file" "multiply" "multiply_schema" |
| name | string |
| description | string |
| price | number |
| hidden | boolean |
| required | boolean |
| min | string |
| max | string |
| step | string |
| default | string |
| pattern | string |
| validation | string |
| shipping_time | integer |
| shipping_date | string <date-time> |
Array of objects | |
| used_schemas | Array of strings |
{- "type": "string",
- "name": "Size",
- "description": "string",
- "price": 9.99,
- "hidden": true,
- "required": true,
- "min": "string",
- "max": "string",
- "step": "string",
- "default": "string",
- "pattern": "string",
- "validation": "string",
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11",
- "options": [
- {
- "name": "XL",
- "price": 3.99,
- "disabled": true,
- "items": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121"
}
]
}
], - "used_schemas": [
- "026bc5f6-8373-4aeb-972e-e78d72a67121"
]
}{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "string",
- "name": "Size",
- "description": "string",
- "price": 9.99,
- "hidden": true,
- "required": true,
- "min": "string",
- "max": "string",
- "step": "string",
- "default": "string",
- "pattern": "string",
- "validation": "string",
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11",
- "options": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "XL",
- "price": 3.99,
- "disabled": true,
- "available": true,
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11",
- "items": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Chain",
- "sku": "K121",
- "quantity": "20",
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11",
- "unlimited_shipping_time": 5,
- "unlimited_shipping_date": "2021-09-13T11:11",
- "availability": [
- {
- "quantity": "20",
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11"
}
]
}
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "used_schemas": [
- "used-schema-ids"
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
}{- "data": {
- "title": "Title",
- "description": "Description SEO",
- "keywords": [
- "PHP"
], - "twitter_card": "summary",
- "no_index": true,
- "og_image": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
}
}| title | string Displayed seo title |
| description | string Displayed SEO description |
| keywords | Array of strings List of SEO keywords |
| twitter_card | string Enum: "summary" "summary_large_image" |
| no_index | boolean Whether seo indexing is disabled |
| og_image_id | string |
{- "title": "Title",
- "description": "Description SEO",
- "keywords": [
- "PHP"
], - "twitter_card": "summary",
- "no_index": true,
- "og_image_id": "0006c3a0-21af-4485-b7fe-9c42233cf03"
}{- "data": {
- "title": "Title",
- "description": "Description SEO",
- "keywords": [
- "PHP"
], - "twitter_card": "summary",
- "no_index": true,
- "og_image": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
}
}| keywords required | Array of strings List of SEO keywords |
object Model excluded from keywords checking |
{- "keywords": [
- "PHP"
], - "excluded": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "model": "Product"
}
}{- "data": {
- "duplicated": true,
- "duplicates": [
- {
- "id": "0006c3a0-21af-4485-b7fe-9c42233cf03a",
- "model_type": "Product"
}
]
}
}| name required | string Setting name |
| value required | string Setting value |
| public required | boolean Whether setting is public |
{- "name": "store_name",
- "value": "Heseya",
- "public": true
}{- "data": {
- "name": "setting-name",
- "value": "string",
- "public": true,
- "permanent": true
}
}| name required | string |
| name required | string Setting name |
| value required | string Setting value |
| public required | boolean Whether setting is public |
{- "name": "store_name",
- "value": "Heseya",
- "public": true
}{- "data": {
- "name": "setting-name",
- "value": "string",
- "public": true,
- "permanent": true
}
}object (MetadataQuery) search by metadata | |
object (MetadataQuery) search by metadata private | |
| ids[] | string Example: ids[]=ids[]=5a61f3a1-1cd1-4e71-bf7d-0d3a159bd6b0&ids[]=33e37b2a-44e9-4d35-88db-d9a79a61e557 Ids array search |
{- "data": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Cancel",
- "color": "8f022c",
- "cancel": true,
- "description": "Your order has been cancelled!",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
]
}| id | string |
| name | string |
| color | string |
| cancel | boolean |
| description | string |
object (Metadata) | |
object (Metadata) |
{- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Cancel",
- "color": "8f022c",
- "cancel": true,
- "description": "Your order has been cancelled!",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Cancel",
- "color": "8f022c",
- "cancel": true,
- "description": "Your order has been cancelled!",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
}| id required | integer |
| id | string |
| name | string |
| color | string |
| cancel | boolean |
| description | string |
{- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Cancel",
- "color": "8f022c",
- "cancel": true,
- "description": "Your order has been cancelled!"
}{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Cancel",
- "color": "8f022c",
- "cancel": true,
- "description": "Your order has been cancelled!",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
}| search | string Full text search |
| name | string Name search |
string Example: email=email@example.com Email search | |
| roles[] | string Example: roles[]=9e2206ff-1edf-49c4-ab6c-ab620f18b98d Search for users in roles by role id |
| consent_name | string Accepted Consent name search |
| consent_id | string Example: consent_id=9e2206ff-1edf-49c4-ab6c-ab620f18b98d Accepted Consent id search |
| sort | string Example: sort=name:desc Sorting string |
| full | boolean Returns details resource |
| limit | number Example: limit=12 Number of elements per page |
object (MetadataQuery) search by metadata | |
object (MetadataQuery) search by metadata private | |
| ids[] | string Example: ids[]=ids[]=5a61f3a1-1cd1-4e71-bf7d-0d3a159bd6b0&ids[]=33e37b2a-44e9-4d35-88db-d9a79a61e557 Ids array search |
{- "data": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "email": "email@example.com",
- "name": "Johny Mielony",
- "avatar": "//www.gravatar.com/avatar/example.jpg",
- "roles": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Admin",
- "description": "Role with permission to everything",
- "assignable": true,
- "deletable": true,
- "users_count": 10,
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "consents": [
- {
- "name": "Consent One",
- "description_html": "<h1>Lorem ipsum dolor sit amet</h1>",
- "required": true,
- "value": true
}
], - "birthdate_date": "2000-01-01",
- "phone": "+48123456789",
- "phone_country": "PL",
- "phone_number": "12 345 67 89",
- "created_at": "2022-12-06T09:11",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
]
}| name | string |
string | |
| password | string |
| birthday_date | string <date> |
| phone | string |
| roles | Array of strings Ids of assigned roles |
object (Metadata) | |
object (Metadata) |
{- "name": "Marianna Szulc",
- "email": "admin@example.com",
- "password": "123@@#abYZ",
- "birthday_date": "2000-01-01",
- "phone": "+48123456789",
- "roles": [
- "026bc5f6-8373-4aeb-972e-e78d72a67121"
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "email": "email@example.com",
- "name": "Johny Mielony",
- "avatar": "//www.gravatar.com/avatar/example.jpg",
- "roles": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Admin",
- "description": "Role with permission to everything",
- "assignable": true,
- "deletable": true,
- "users_count": 10,
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "consents": [
- {
- "name": "Consent One",
- "description_html": "<h1>Lorem ipsum dolor sit amet</h1>",
- "required": true,
- "value": true
}
], - "birthdate_date": "2000-01-01",
- "phone": "+48123456789",
- "phone_country": "PL",
- "phone_number": "12 345 67 89",
- "created_at": "2022-12-06T09:11",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "permissions": [
- "roles.show_details"
], - "preferences": {
- "successful_login_attempt_alert": true,
- "failed_login_attempt_alert": true,
- "new_localization_login_alert": true,
- "recovery_code_changed_alert": true
}
}
}| id required | string Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0 |
{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "email": "email@example.com",
- "name": "Johny Mielony",
- "avatar": "//www.gravatar.com/avatar/example.jpg",
- "roles": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Admin",
- "description": "Role with permission to everything",
- "assignable": true,
- "deletable": true,
- "users_count": 10,
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "consents": [
- {
- "name": "Consent One",
- "description_html": "<h1>Lorem ipsum dolor sit amet</h1>",
- "required": true,
- "value": true
}
], - "birthdate_date": "2000-01-01",
- "phone": "+48123456789",
- "phone_country": "PL",
- "phone_number": "12 345 67 89",
- "created_at": "2022-12-06T09:11",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "permissions": [
- "roles.show_details"
], - "preferences": {
- "successful_login_attempt_alert": true,
- "failed_login_attempt_alert": true,
- "new_localization_login_alert": true,
- "recovery_code_changed_alert": true
}
}
}| id required | string Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0 |
| name | string |
string | |
| birthday_date | string <date> |
| phone | string |
| roles | Array of strings Ids of assigned roles |
{- "name": "Marianna Szulc",
- "email": "admin@example.com",
- "birthday_date": "2000-01-01",
- "phone": "+48123456789",
- "roles": [
- "026bc5f6-8373-4aeb-972e-e78d72a67121"
]
}{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "email": "email@example.com",
- "name": "Johny Mielony",
- "avatar": "//www.gravatar.com/avatar/example.jpg",
- "roles": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Admin",
- "description": "Role with permission to everything",
- "assignable": true,
- "deletable": true,
- "users_count": 10,
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
], - "consents": [
- {
- "name": "Consent One",
- "description_html": "<h1>Lorem ipsum dolor sit amet</h1>",
- "required": true,
- "value": true
}
], - "birthdate_date": "2000-01-01",
- "phone": "+48123456789",
- "phone_country": "PL",
- "phone_number": "12 345 67 89",
- "created_at": "2022-12-06T09:11",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "permissions": [
- "roles.show_details"
], - "preferences": {
- "successful_login_attempt_alert": true,
- "failed_login_attempt_alert": true,
- "new_localization_login_alert": true,
- "recovery_code_changed_alert": true
}
}
}| id required | string Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0 |
| faktura | string |
{- "faktura": "FV/2022/03/10/005"
}{- "data": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}| id required | string Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0 |
| faktura | string |
{- "faktura": "FV/2022/03/10/005"
}{- "data": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}| id required | string Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0 |
| faktura | string |
{- "faktura": "FV/2022/03/10/005"
}{- "data": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}| id required | string Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0 |
| faktura | string |
{- "faktura": "FV/2022/03/10/005"
}{- "data": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}| id required | string Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0 |
| faktura | string |
{- "faktura": "FV/2022/03/10/005"
}{- "data": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}| id required | string Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0 |
| faktura | string |
{- "faktura": "FV/2022/03/10/005"
}{- "data": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}| id required | string Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0 |
| faktura | string |
{- "faktura": "FV/2022/03/10/005"
}{- "data": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}| id required | string Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0 |
| faktura | string |
{- "faktura": "FV/2022/03/10/005"
}{- "data": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}| id required | string Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0 |
| faktura | string |
{- "faktura": "FV/2022/03/10/005"
}{- "data": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}| id required | string Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0 |
| faktura | string |
{- "faktura": "FV/2022/03/10/005"
}{- "data": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}| id required | string Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0 |
| faktura | string |
{- "faktura": "FV/2022/03/10/005"
}{- "data": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}| id required | string Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0 |
| faktura | string |
{- "faktura": "FV/2022/03/10/005"
}{- "data": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}| id required | string Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0 |
| faktura | string |
{- "faktura": "FV/2022/03/10/005"
}{- "data": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}| id required | string Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0 |
| faktura | string |
{- "faktura": "FV/2022/03/10/005"
}{- "data": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}| id required | string Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0 |
| faktura | string |
{- "faktura": "FV/2022/03/10/005"
}{- "data": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}| id required | string Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0 |
| faktura | string |
{- "faktura": "FV/2022/03/10/005"
}{- "data": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}| id required | string Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0 |
| faktura | string |
{- "faktura": "FV/2022/03/10/005"
}{- "data": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}| id required | string Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0 |
| faktura | string |
{- "faktura": "FV/2022/03/10/005"
}{- "data": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}| id required | string Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0 |
| faktura | string |
{- "faktura": "FV/2022/03/10/005"
}{- "data": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}| id required | string Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0 |
| faktura | string |
{- "faktura": "FV/2022/03/10/005"
}{- "data": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}| id required | string Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0 |
| faktura | string |
{- "faktura": "FV/2022/03/10/005"
}{- "data": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}| id required | string Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0 |
| faktura | string |
{- "faktura": "FV/2022/03/10/005"
}{- "data": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}| id required | string Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0 |
| faktura | string |
{- "faktura": "FV/2022/03/10/005"
}{- "data": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}| id required | string Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0 |
| faktura | string |
{- "faktura": "FV/2022/03/10/005"
}{- "data": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}| id required | string Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0 |
| faktura | string |
{- "faktura": "FV/2022/03/10/005"
}{- "data": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}| id required | string Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0 |
| faktura | string |
{- "faktura": "FV/2022/03/10/005"
}{- "data": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}| id required | string Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0 |
| faktura | string |
{- "faktura": "FV/2022/03/10/005"
}{- "data": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}| id required | string Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0 |
| faktura | string |
{- "faktura": "FV/2022/03/10/005"
}{- "data": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}| id required | string Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0 |
| faktura | string |
{- "faktura": "FV/2022/03/10/005"
}{- "data": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}| id required | string Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0 |
| faktura | string |
{- "faktura": "FV/2022/03/10/005"
}{- "data": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}| id required | string Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0 |
| faktura | string |
{- "faktura": "FV/2022/03/10/005"
}{- "data": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}| id required | string Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0 |
| faktura | string |
{- "faktura": "FV/2022/03/10/005"
}{- "data": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}| id required | string Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0 |
| faktura | string |
{- "faktura": "FV/2022/03/10/005"
}{- "data": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}| id required | string Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0 |
| faktura | string |
{- "faktura": "FV/2022/03/10/005"
}{- "data": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}| id required | string Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0 |
| faktura | string |
{- "faktura": "FV/2022/03/10/005"
}{- "data": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}| id required | string Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0 |
| faktura | string |
{- "faktura": "FV/2022/03/10/005"
}{- "data": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}| id required | string Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0 |
| faktura | string |
{- "faktura": "FV/2022/03/10/005"
}{- "data": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}| id required | string Example: 1c8705ce-5fae-4468-b88a-8784cb5414a0 |
| faktura | string |
{- "faktura": "FV/2022/03/10/005"
}{- "data": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}| search | string Full text search |
| global | boolean search by global flag |
object (MetadataQuery) search by metadata | |
object (MetadataQuery) search by metadata private | |
| name | string Name search |
| ids[] | string Example: ids[]=ids[]=5a61f3a1-1cd1-4e71-bf7d-0d3a159bd6b0&ids[]=33e37b2a-44e9-4d35-88db-d9a79a61e557 Ids array search |
{- "data": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Screen size",
- "slug": "screen-size",
- "description": "Presented number is size of screen monitor",
- "min": "22",
- "max": "27",
- "type": 1,
- "global": true,
- "sortable": true,
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
]
}| id | string |
| name | string Name of attribute |
| slug | string Slug of name attribute |
| description | string Description of attribute |
| min | integer Lowest value from options |
| max | integer Highest value from options |
| type | integer Type of attribute |
| global | boolean Possibility to use attribute in search |
| sortable | boolean Parameter for storefront |
object (Metadata) | |
object (Metadata) |
{- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Screen size",
- "slug": "screen-size",
- "description": "Presented number is size of screen monitor",
- "min": "22",
- "max": "27",
- "type": 1,
- "global": true,
- "sortable": true,
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Screen size",
- "slug": "screen-size",
- "description": "Presented number is size of screen monitor",
- "min": "22",
- "max": "27",
- "type": 1,
- "global": true,
- "sortable": true,
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
}{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Screen size",
- "slug": "screen-size",
- "description": "Presented number is size of screen monitor",
- "min": "22",
- "max": "27",
- "type": 1,
- "global": true,
- "sortable": true,
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
}| id required | integer |
| id | string |
| name | string Name of attribute |
| slug | string Slug of name attribute |
| description | string Description of attribute |
| min | integer Lowest value from options |
| max | integer Highest value from options |
| type | integer Type of attribute |
| global | boolean Possibility to use attribute in search |
| sortable | boolean Parameter for storefront |
{- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Screen size",
- "slug": "screen-size",
- "description": "Presented number is size of screen monitor",
- "min": "22",
- "max": "27",
- "type": 1,
- "global": true,
- "sortable": true
}{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Screen size",
- "slug": "screen-size",
- "description": "Presented number is size of screen monitor",
- "min": "22",
- "max": "27",
- "type": 1,
- "global": true,
- "sortable": true,
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
}| id required | integer |
object search by metadata | |
| ids[] | string Example: ids[]=ids[]=5a61f3a1-1cd1-4e71-bf7d-0d3a159bd6b0&ids[]=33e37b2a-44e9-4d35-88db-d9a79a61e557 Ids array search |
[- {
- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Screen size",
- "index": 1,
- "value_number": "27",
- "value_date": "2022-02-22",
- "attribute_id": "026bc5f6-8373-4aeb-972e-e78d72a67121"
}
}
]| id required | integer |
| id | string |
| name | string Name of attribute option |
| index | integer Index of attribute option |
| value_number | number Number value attribute option |
| value_date | string <date> Date value attribute option |
| attribute_id | string |
object (Metadata) | |
object (Metadata) |
{- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Screen size",
- "index": 1,
- "value_number": "27",
- "value_date": "2022-02-22",
- "attribute_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Screen size",
- "index": 1,
- "value_number": "27",
- "value_date": "2022-02-22",
- "attribute_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
}| attribute_id required | string |
| option_id required | string |
| id | string |
| name | string Name of attribute option |
| index | integer Index of attribute option |
| value_number | number Number value attribute option |
| value_date | string <date> Date value attribute option |
| attribute_id | string |
{- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Screen size",
- "index": 1,
- "value_number": "27",
- "value_date": "2022-02-22",
- "attribute_id": "026bc5f6-8373-4aeb-972e-e78d72a67121"
}{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Screen size",
- "index": 1,
- "value_number": "27",
- "value_date": "2022-02-22",
- "attribute_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
}{- "data": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Consent One",
- "description_html": "<h1>Lorem ipsum dolor sit amet</h1>",
- "required": true,
- "created_at": "2021-09-13T11:11",
- "updated_at": "2021-09-13T11:11"
}
]
}| name | string |
| description_html | string |
| required | boolean |
{- "name": "Consent One",
- "description_html": "<h1>Lorem ipsum dolor sit amet</h1>",
- "required": true
}{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Consent One",
- "description_html": "<h1>Lorem ipsum dolor sit amet</h1>",
- "required": true,
- "created_at": "2021-09-13T11:11",
- "updated_at": "2021-09-13T11:11"
}
}{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Consent One",
- "description_html": "<h1>Lorem ipsum dolor sit amet</h1>",
- "required": true,
- "created_at": "2021-09-13T11:11",
- "updated_at": "2021-09-13T11:11"
}
}| id required | integer |
| name | string |
| description_html | string |
| required | boolean |
{- "name": "Consent One",
- "description_html": "<h1>Lorem ipsum dolor sit amet</h1>",
- "required": true
}{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Consent One",
- "description_html": "<h1>Lorem ipsum dolor sit amet</h1>",
- "required": true,
- "created_at": "2021-09-13T11:11",
- "updated_at": "2021-09-13T11:11"
}
}{- "data": [
- {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "product": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "slug": "white-socks",
- "name": "White socks",
- "price": 10.99,
- "price_min": 11.99,
- "price_max": 19.99,
- "price_min_initial": 12.99,
- "price_max_initial": 20.99,
- "public": true,
- "visible": true,
- "available": true,
- "quantity_step": 0.05,
- "quantity": 20,
- "google_product_category": 2271,
- "vat_rate": 23,
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11",
- "shipping_digital": true,
- "purchase_limit_per_user": 5,
- "cover": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "tags": [
- {
- "name": "Sale",
- "color": 111111
}
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "has_schemas": true,
- "attributes": [
- {
- "name": "Screen size",
- "selected_options": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Screen size",
- "index": 1,
- "value_number": "27",
- "value_date": "2022-02-22",
- "attribute_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
}
]
}, - "created_at": "2017-07-21T17:32:28Z"
}
]
}| product_id | string |
{- "product_id": "026bc5f6-8373-4aeb-972e-e78d72a67121"
}{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "product": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "slug": "white-socks",
- "name": "White socks",
- "price": 10.99,
- "price_min": 11.99,
- "price_max": 19.99,
- "price_min_initial": 12.99,
- "price_max_initial": 20.99,
- "public": true,
- "visible": true,
- "available": true,
- "quantity_step": 0.05,
- "quantity": 20,
- "google_product_category": 2271,
- "vat_rate": 23,
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11",
- "shipping_digital": true,
- "purchase_limit_per_user": 5,
- "cover": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "tags": [
- {
- "name": "Sale",
- "color": 111111
}
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "has_schemas": true,
- "attributes": [
- {
- "name": "Screen size",
- "selected_options": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Screen size",
- "index": 1,
- "value_number": "27",
- "value_date": "2022-02-22",
- "attribute_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
}
]
}, - "created_at": "2017-07-21T17:32:28Z"
}
}{- "data": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "product": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "slug": "white-socks",
- "name": "White socks",
- "price": 10.99,
- "price_min": 11.99,
- "price_max": 19.99,
- "price_min_initial": 12.99,
- "price_max_initial": 20.99,
- "public": true,
- "visible": true,
- "available": true,
- "quantity_step": 0.05,
- "quantity": 20,
- "google_product_category": 2271,
- "vat_rate": 23,
- "shipping_time": 5,
- "shipping_date": "2021-09-13T11:11",
- "shipping_digital": true,
- "purchase_limit_per_user": 5,
- "cover": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "type": "photo",
- "alt": "Example media alt description",
- "slug": "test-slug",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}, - "tags": [
- {
- "name": "Sale",
- "color": 111111
}
], - "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "has_schemas": true,
- "attributes": [
- {
- "name": "Screen size",
- "selected_options": {
- "id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "name": "Screen size",
- "index": 1,
- "value_number": "27",
- "value_date": "2022-02-22",
- "attribute_id": "026bc5f6-8373-4aeb-972e-e78d72a67121",
- "metadata": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}, - "metadata_private": {
- "invoice": "FV/2022/03/10/005",
- "erp_id": 132432153,
- "synced": true
}
}
}
]
}, - "created_at": "2017-07-21T17:32:28Z"
}
}